minca
ApiSchemasVariables

Variable: comment

const comment: object & Typed<{
  mentions?: readonly string[];
  replyingTo?: string;
  respondingTo?: string;
  text: string;
}>;

Defined in: packages/core/src/schemas/library/annotations.ts:32

A comment on any record, optionally a reply to another comment. As on a std.message, mentions names who it calls on and replyingTo whose comment it answers, and both are topics: "mentions me" and "replies to me" can be asked of a keeper that can't read it. Commenting is also how to mention someone on a record of any kind, whatever its own definition holds.

Type Declaration

description

readonly description: "A comment on any record, optionally replying to another comment. To chat, use std.message." = 'A comment on any record, optionally replying to another comment. To chat, use std.message.';
readonly links: object;

links.about

readonly about: LinkDeclaration;

links.replyTo

readonly replyTo: object;

links.replyTo.cardinality

readonly cardinality: "one" = 'one';

links.replyTo.description

readonly description: "The comment this replies to" = 'The comment this replies to';

links.replyTo.to

readonly to: readonly ["std.comment"];

links.shares

readonly shares: object;

links.shares.cardinality

readonly cardinality: "one" = 'one';

links.shares.description

readonly description: "A record this comment shares, like a poll" = 'A record this comment shares, like a poll';

links.shares.to

readonly to: "*" = '*';

name

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

schema

readonly schema: object;

schema.properties

readonly properties: object;

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

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

schema.properties.respondingTo

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

schema.properties.text

readonly text: object;

schema.properties.text.maxLength

readonly maxLength: 10000 = 10000;

schema.properties.text.minLength

readonly minLength: 1 = 1;

schema.properties.text.type

readonly type: "string" = 'string';

schema.required

readonly required: readonly ["text"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Comment" = 'Comment';

topics

readonly topics: readonly ["mentions", "replyingTo", "respondingTo"];

On this page