MediaSelector

A Selector that provide methods to list and request information on MediaObjects.

You can use a MediaSelector by accessing StarlightClient.media.

Index

Methods

• get
• list

Methods

get

• get(id: string | number, params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<MediaObject>>

• Returns a StarlightItemResponse with a single MediaObject.

  Note: MediaObjects are identified by their IDs, since they don’t have slugs.

  @example

  Requesting information from a media object of id “123456789”.

  import Starlight from '@starlightcms/js-sdk'
  
  const response = await Starlight.media.get('123456789')

  ---

  Parameters

  • id: string | number

    The media object ID.

  • optionalparams: BaseRequestParameters

    An optional object of request parameters.

  • optionaloptions: RequestInit

    An optional object of fetch options. See https://developer.mozilla.org/en-US/docs/Web/API/RequestInit for more info.

  Returns Promise<StarlightItemResponse<MediaObject>>

list

• list(params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightListResponse<MediaObject>>

• Returns a StarlightListResponse with the list of MediaObjects in this workspace.

  @example

  Requesting all media objects from the workspace.

  import Starlight from '@starlightcms/js-sdk'
  
  const response = await Starlight.media.list()

  ---

  Parameters

  • optionalparams: BaseRequestParameters

    An optional object of request parameters.

  • optionaloptions: RequestInit

    An optional object of fetch options. See https://developer.mozilla.org/en-US/docs/Web/API/RequestInit for more info.

  Returns Promise<StarlightListResponse<MediaObject>>