minca
ApiSchemasVariables

Variable: list

const list: object & Typed<{
  description?: string;
  icon?: string;
  kind?: string;
  title: string;
}>;

Defined in: packages/core/src/schemas/library/media.ts:25

A list of anything: shopping, packing, reading, people, a playlist. kind is a hint for how to show it, not a constraint.

Type Declaration

description

readonly description: "A named, ordered group of anything that exists while empty: a checklist, a folder, an album, a playlist, a category (`kind`). Each member is a std.list-item in it, about the record it stands for. For loose labels, use std.tag." = 'A named, ordered group of anything that exists while empty: a checklist, a folder, an album, a playlist, a category (`kind`). Each member is a std.list-item in it, about the record it stands for. For loose labels, use std.tag.';

name

readonly name: "std.list" = 'std.list';

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.description

readonly description: object;

schema.properties.description.maxLength

maxLength: number = max;

schema.properties.description.minLength?

minLength?: number = min;

schema.properties.description.type

type: "string";

schema.properties.icon

readonly icon: object;

schema.properties.icon.maxLength

maxLength: number = max;

schema.properties.icon.minLength?

minLength?: number = min;

schema.properties.icon.type

type: "string";

schema.properties.kind

readonly kind: object;

schema.properties.kind.maxLength

maxLength: number = max;

schema.properties.kind.minLength?

minLength?: number = min;

schema.properties.kind.type

type: "string";

schema.properties.title

readonly title: object;

schema.properties.title.maxLength

maxLength: number = max;

schema.properties.title.minLength?

minLength?: number = min;

schema.properties.title.type

type: "string";

schema.required

readonly required: readonly ["title"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "List" = 'List';

On this page