minca
ApiSchemasVariables

Variable: channel

const channel: object & Typed<{
  name: string;
  position?: string;
  topic?: string;
}>;

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

A channel in a space with more than one conversation. Messages link it as their channel.

Type Declaration

description

readonly description: "A named conversation within a space." = 'A named conversation within a space.';

name

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

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.name

readonly name: object;

schema.properties.name.maxLength

maxLength: number = max;

schema.properties.name.minLength?

minLength?: number = min;

schema.properties.name.type

type: "string";

schema.properties.position

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

schema.properties.topic

readonly topic: object;

schema.properties.topic.maxLength

maxLength: number = max;

schema.properties.topic.minLength?

minLength?: number = min;

schema.properties.topic.type

type: "string";

schema.required

readonly required: readonly ["name"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Channel" = 'Channel';

On this page