ModelCategorySelector

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

You can use a ModelCategorySelector by accessing ModelInstance.categories.

Index

Methods

• get
• list

Methods

get

• get(slug: string): Promise<StarlightItemResponse<ModelCategory>>

• Returns a StarlightItemResponse with a single ModelCategory.

  @example

  Requesting information from a category “premium” from a model of slug “plans”.

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

  ---

  Parameters

  • slug: string

    The category slug.

  Returns Promise<StarlightItemResponse<ModelCategory>>

list

• list(options?: ListModelCategoriesOptions): Promise<StarlightListResponse<ModelCategory>>

• Returns a StarlightListResponse with a list of ModelCategories.

  @example

  Requesting all categories from a model.

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

  ---

  Parameters

  • optionaloptions: ListModelCategoriesOptions

    An optional object of request parameters. See ListModelCategoriesOptions for all available options.

  Returns Promise<StarlightListResponse<ModelCategory>>