Application Load

ICatalogLoadResponse

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

ICatalogLoadResponse

Category tree in tree, childless category IDs in childfree, and all returned category IDs in unique_ids.

src/lib/interfaces/orionplace/catalog/ICatalogDirectory.ts
TypeScript
export interface ICatalogLoadResponse {
  // Field or general errors; null on success.
  form_errors: Record<string, ApiFormError[]> | null;
  // Success message, or null.
  success_message: string | null;
  // Category tree in `tree`, childless category IDs in `childfree`, and all
  // returned category IDs in `unique_ids`.
  page_data: {
    // Array of public root categories. Nested `childs` arrays contain public
    // descendants through depth 3.
    tree: ICategory[];
    // IDs of returned categories with no stored subcategories (`numchild` 0). A
    // category whose children are all hidden or deeper than level 3 is not
    // listed here; its `childs` is empty.
    childfree: number[];
    // IDs of categories in the returned tree. Use the order of `tree` and
    // `childs` for display.
    unique_ids: number[];
  } | null;
}