CollectionInstance <C>

An Instance that provide methods to request information and items from a specific Collection.

You can access a CollectionInstance using StarlightClient.collection.

To list all workspace collections, use a CollectionSelector.

Index

Methods

• get
• items

Methods

get

• get(params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<Collection<CollectionTypeMapper<C>>>>

• Returns a StarlightItemResponse with a single Collection.

  @example

  Requesting information from a collection of slug featured-news.

  import Starlight from '@starlightcms/js-sdk'
  
  const response = await Starlight.collection('featured-news').get()

  ---

  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<StarlightItemResponse<Collection<CollectionTypeMapper<C>>>>

items

• items(params?: ListCollectionItemsParams | WithQueryableFieldsOnModelables<C>, options?: RequestInit): Promise<StarlightListResponse<C>>

• Returns a StarlightListResponse with the list of items of this Collection. The returned list type depends on the collection type: a list of Entries for a collection of type entry, a list of MediaObjects for a collection o type media, and so on.

  If the given Collection is not typed, this method will return a response of StarlightListResponse<unknown>.

  @example

  Requesting all items from an Entry collection of slug featured-news.

  import Starlight from '@starlightcms/js-sdk'
  
  const response = await Starlight.collection('featured-news').items()

  @example

  Explicitly typing the returned items. Only possible in TypeScript.

  import Starlight from '@starlightcms/js-sdk'
  import { NewsPostType } from '../types'
  
  // response will be StarlightListResponse<Entry<NewsPostType>>
  const response = await Starlight.collection<Entry<NewsPostType>>('featured-news').items()

  ---

  Parameters

  • optionalparams: ListCollectionItemsParams | WithQueryableFieldsOnModelables<C>

    An optional object of request parameters. See ListCollectionItemsParams for all available parameters. field:foo syntax is also supported, see QueryableFields for more info.

  • 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<C>>