minca
ApiSchemasVariables

Variable: inbox

const inbox: object & Typed<{
  gen: number;
  name?: string;
  places: readonly string[];
  username?: string;
  usernameUntil?: number;
}>;

Defined in: packages/core/src/schemas/contacts.ts:62

Your inbox (node.inbox): which one it is and where its knocks wait. Its keys are derived from the contact key and gen; a new gen is a new inbox, and codes for the old one stop working. The newest record is the inbox.

Type Declaration

description

readonly description: "Where people you share no space with can ask to become your contact." = 'Where people you share no space with can ask to become your contact.';

name

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

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.gen

readonly gen: object;

schema.properties.gen.description

readonly description: "Which inbox: its keys are derived from it" = 'Which inbox: its keys are derived from it';

schema.properties.gen.minimum

readonly minimum: 0 = 0;

schema.properties.gen.type

readonly type: "integer" = 'integer';

schema.properties.name

readonly name: object;

schema.properties.name.description

readonly description: "The name its code gives, shown to whoever knocks" = 'The name its code gives, shown to whoever knocks';

schema.properties.name.maxLength

readonly maxLength: 64 = 64;

schema.properties.name.type

readonly type: "string" = 'string';

schema.properties.places

readonly places: object;

schema.properties.places.description

readonly description: "Whose mailboxes hold its knocks" = 'Whose mailboxes hold its knocks';

schema.properties.places.items

readonly items: object;

schema.properties.places.items.maxLength

readonly maxLength: 200 = 200;

schema.properties.places.items.type

readonly type: "string" = 'string';

schema.properties.places.maxItems

readonly maxItems: 3 = 3;

schema.properties.places.minItems

readonly minItems: 1 = 1;

schema.properties.places.type

readonly type: "array" = 'array';

schema.properties.username

readonly username: object;

schema.properties.username.description

readonly description: "The username that leads to it: name@domain" = 'The username that leads to it: name@domain';

schema.properties.username.maxLength

readonly maxLength: 320 = 320;

schema.properties.username.type

readonly type: "string" = 'string';

schema.properties.usernameUntil

readonly usernameUntil: object;

schema.properties.usernameUntil.description

readonly description: "When the username lapses unless claimed again, ms" = 'When the username lapses unless claimed again, ms';

schema.properties.usernameUntil.type

readonly type: "number" = 'number';

schema.required

readonly required: readonly ["gen", "places"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Inbox" = 'Inbox';

On this page