ModelSelector

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

You can use a ModelSelector by accessing StarlightClient.models.

To list entries or categories of a specific model, use a ModelInstance.

Index

Methods

• get
• list

Methods

get

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

• Returns a StarlightItemResponse with a single Model.

  Note that this method only returns information on a model, like its title, slug, creation date, and entry count. If you want list its entries or categories, you need to use a ModelInstance.

  @example

  Requesting information from a model of slug “clients”.

  import Starlight from '@starlightcms/js-sdk'
  
  const response = await Starlight.posts.entries.get('clients')

  ---

  Parameters

  • slug: string

    The model 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<Model>>

list

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

• Returns a StarlightListResponse with a list of Models.

  @example

  Requesting all models from a workspace.

  import Starlight from '@starlightcms/js-sdk'
  
  const response = await Starlight.models.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<Model>>