minca
ApiSchemasVariables

Variable: spaceInvite

const spaceInvite: object & Typed<{
  invite: string;
  space: string;
}>;

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

An invite to a space, left for a contact in your space for two with them: only the two of you read it there, so it needs no sealing. What space it is, and its name, are read from the signed invite; space only keys the record. Joining deletes it, and the inviter closes the invite once they are in.

Type Declaration

description

readonly description: "An invite to a space, left for a contact in your space for two." = 'An invite to a space, left for a contact in your space for two.';

name

readonly name: "std.space-invite" = 'std.space-invite';

rules

readonly rules: object;

rules.onePer

readonly onePer: readonly ["space"];

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.invite

readonly invite: object;

schema.properties.invite.description

readonly description: "The invite, as spaces.join takes it" = 'The invite, as spaces.join takes it';

schema.properties.invite.maxLength

readonly maxLength: 12000 = 12000;

schema.properties.invite.type

readonly type: "string" = 'string';

schema.properties.space

readonly space: object;

schema.properties.space.description

readonly description: "The space it invites them to" = 'The space it invites them to';

schema.properties.space.maxLength

readonly maxLength: 256 = 256;

schema.properties.space.type

readonly type: "string" = 'string';

schema.required

readonly required: readonly ["space", "invite"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Space invite" = 'Space invite';

On this page