CollectionSelector

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

You can use a CollectionSelector by accessing StarlightClient.collections.

To get items from a specific collection, use a CollectionInstance.

Index

Methods

• get
• list

Methods

get

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

• Returns a StarlightItemResponse with a single Collection.

  @example

  Requesting information from a collection of slug “event-photos”.

  import Starlight from '@starlightcms/js-sdk'
  
  const response = await Starlight.collections.get('event-photos')

  ---

  Parameters

  • slug: string | number

    The collection slug.

  • 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<Collection<string>>>

list

• list(params?: ListCollectionsParams, options?: RequestInit): Promise<StarlightListResponse<Collection<string>>>

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

  @example

  Requesting all collections from the workspace.

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

  @example

  Paginating and searching on the last example.

  import Starlight from '@starlightcms/js-sdk'
  
  const response = await Starlight.collections.list({
    page: 2,
    query: 'photos',
  })

  ---

  Parameters

  • optionalparams: ListCollectionsParams

    An optional object of request parameters. See ListCollectionsParams for all available 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<Collection<string>>>