minca
ApiSchemasVariables

Variable: work

const work: object & Typed<{
  cover?: {
     hash: string;
     key?: string;
     mime: string;
     name?: string;
     salt?: string;
     size: number;
  };
  creators?: readonly string[];
  ids?: {
     imdb?: string;
     isbn?: string;
     mbid?: string;
     wikidata?: string;
  };
  kind: "other" | "album" | "book" | "film" | "show" | "game" | "podcast";
  title: string;
  year?: number;
}>;

Defined in: packages/core/src/schemas/library/life.ts:192

A book, film, show, album or game, known by its ids. Progress is about it.

Type Declaration

description

readonly description: "A book, film, show, album or game." = 'A book, film, show, album or game.';

name

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

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.cover

readonly cover: object & object;
Type Declaration
properties
properties: object;
properties.hash
hash: object;
properties.hash.maxLength
maxLength: number = 64;
properties.hash.minLength
minLength: number = 64;
properties.hash.type
type: "string";
properties.key
key: object;
properties.key.maxLength
maxLength: number = 22;
properties.key.minLength
minLength: number = 22;
properties.key.type
type: "string";
properties.mime
mime: object;
properties.mime.maxLength
maxLength: number = max;
properties.mime.minLength?
minLength?: number = min;
properties.mime.type
type: "string";
properties.name
name: object;
properties.name.maxLength
maxLength: number = max;
properties.name.minLength?
minLength?: number = min;
properties.name.type
type: "string";
properties.salt
salt: object;
properties.salt.maxLength
maxLength: number = 22;
properties.salt.minLength
minLength: number = 22;
properties.salt.type
type: "string";
properties.size
size: object;
properties.size.minimum
minimum: number = 0;
properties.size.type
type: "integer";
required
required: readonly ["hash", "size", "mime"];
type
type: "object";
x-kind
readonly "x-kind": "file";

schema.properties.creators

readonly creators: object;

schema.properties.creators.items

readonly items: object;

schema.properties.creators.items.maxLength

maxLength: number = max;

schema.properties.creators.items.minLength?

minLength?: number = min;

schema.properties.creators.items.type

type: "string";

schema.properties.creators.maxItems

readonly maxItems: 20 = 20;

schema.properties.creators.type

readonly type: "array" = 'array';

schema.properties.ids

readonly ids: object;

schema.properties.ids.properties

readonly properties: object;

schema.properties.ids.properties.imdb

readonly imdb: object;

schema.properties.ids.properties.imdb.maxLength

maxLength: number = max;

schema.properties.ids.properties.imdb.minLength?

minLength?: number = min;

schema.properties.ids.properties.imdb.type

type: "string";

schema.properties.ids.properties.isbn

readonly isbn: object;

schema.properties.ids.properties.isbn.maxLength

maxLength: number = max;

schema.properties.ids.properties.isbn.minLength?

minLength?: number = min;

schema.properties.ids.properties.isbn.type

type: "string";

schema.properties.ids.properties.mbid

readonly mbid: object;

schema.properties.ids.properties.mbid.maxLength

maxLength: number = max;

schema.properties.ids.properties.mbid.minLength?

minLength?: number = min;

schema.properties.ids.properties.mbid.type

type: "string";

schema.properties.ids.properties.wikidata

readonly wikidata: object;

schema.properties.ids.properties.wikidata.maxLength

maxLength: number = max;

schema.properties.ids.properties.wikidata.minLength?

minLength?: number = min;

schema.properties.ids.properties.wikidata.type

type: "string";

schema.properties.ids.type

readonly type: "object" = 'object';

schema.properties.kind

readonly kind: object;

schema.properties.kind.enum

enum: ("other" | "album" | "book" | "film" | "show" | "game" | "podcast")[];

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.properties.year

readonly year: object;

schema.properties.year.maximum?

maximum?: number = max;

schema.properties.year.minimum

minimum: number = min;

schema.properties.year.type

type: "integer";

schema.required

readonly required: readonly ["kind", "title"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Work" = 'Work';

On this page

Type Declarationdescriptionnameschemaschema.propertiesschema.properties.coverType Declarationpropertiesproperties.hashproperties.hash.maxLengthproperties.hash.minLengthproperties.hash.typeproperties.keyproperties.key.maxLengthproperties.key.minLengthproperties.key.typeproperties.mimeproperties.mime.maxLengthproperties.mime.minLength?properties.mime.typeproperties.nameproperties.name.maxLengthproperties.name.minLength?properties.name.typeproperties.saltproperties.salt.maxLengthproperties.salt.minLengthproperties.salt.typeproperties.sizeproperties.size.minimumproperties.size.typerequiredtypex-kindschema.properties.creatorsschema.properties.creators.itemsschema.properties.creators.items.maxLengthschema.properties.creators.items.minLength?schema.properties.creators.items.typeschema.properties.creators.maxItemsschema.properties.creators.typeschema.properties.idsschema.properties.ids.propertiesschema.properties.ids.properties.imdbschema.properties.ids.properties.imdb.maxLengthschema.properties.ids.properties.imdb.minLength?schema.properties.ids.properties.imdb.typeschema.properties.ids.properties.isbnschema.properties.ids.properties.isbn.maxLengthschema.properties.ids.properties.isbn.minLength?schema.properties.ids.properties.isbn.typeschema.properties.ids.properties.mbidschema.properties.ids.properties.mbid.maxLengthschema.properties.ids.properties.mbid.minLength?schema.properties.ids.properties.mbid.typeschema.properties.ids.properties.wikidataschema.properties.ids.properties.wikidata.maxLengthschema.properties.ids.properties.wikidata.minLength?schema.properties.ids.properties.wikidata.typeschema.properties.ids.typeschema.properties.kindschema.properties.kind.enumschema.properties.titleschema.properties.title.maxLengthschema.properties.title.minLength?schema.properties.title.typeschema.properties.yearschema.properties.year.maximum?schema.properties.year.minimumschema.properties.year.typeschema.requiredschema.typetitle