minca
ApiSchemasVariables

Variable: note

const note: object & Typed<{
  color?: string;
  content?: string;
  mentions?: readonly string[];
  pinned?: boolean;
  title?: string;
}>;

Defined in: packages/core/src/schemas/library/publishing.ts:294

A note, as a notes app keeps them.

Type Declaration

description

readonly description: "A note: a title and some text. A page anyone edits under one name is std.wiki-page; a document several people write at once is std.doc." = 'A note: a title and some text. A page anyone edits under one name is std.wiki-page; a document several people write at once is std.doc.';

name

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

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.color

readonly color: object;

schema.properties.color.maxLength

maxLength: number = max;

schema.properties.color.minLength?

minLength?: number = min;

schema.properties.color.type

type: "string";

schema.properties.content

readonly content: object;

schema.properties.content.maxLength

maxLength: number = max;

schema.properties.content.minLength?

minLength?: number = min;

schema.properties.content.type

type: "string";

schema.properties.mentions

readonly mentions: object;

schema.properties.mentions.items

items: object & object;
Type Declaration
maxLength
maxLength: number = max;
minLength?
minLength?: number = min;
type
type: "string";
x-kind
readonly "x-kind": "did";

schema.properties.mentions.maxItems

maxItems: number = max;

schema.properties.mentions.type

type: "array";

schema.properties.pinned

readonly pinned: object;

schema.properties.pinned.type

readonly type: "boolean" = 'boolean';

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.type

readonly type: "object" = 'object';

title

readonly title: "Note" = 'Note';

topics

readonly topics: readonly ["mentions"];

On this page