minca
ApiSchemasVariables

Variable: poll

const poll: object & Typed<{
  closed?: boolean;
  options: readonly string[];
  question: string;
}>;

Defined in: packages/core/src/schemas/library/community.ts:17

A question with fixed options. The options cannot change once it is asked — votes point at them by position — but whoever asked can close it.

Type Declaration

description

readonly description: "A question with options to vote on." = 'A question with options to vote on.';

name

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

rules

readonly rules: object;

rules.fixed

readonly fixed: readonly ["options"];

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.closed

readonly closed: object;

schema.properties.closed.description

readonly description: "No more votes, as the asker sees it" = 'No more votes, as the asker sees it';

schema.properties.closed.type

readonly type: "boolean" = 'boolean';

schema.properties.options

readonly options: object;

schema.properties.options.items

readonly items: object;

schema.properties.options.items.maxLength

readonly maxLength: 200 = 200;

schema.properties.options.items.minLength

readonly minLength: 1 = 1;

schema.properties.options.items.type

readonly type: "string" = 'string';

schema.properties.options.type

readonly type: "array" = 'array';

schema.properties.question

readonly question: object;

schema.properties.question.maxLength

readonly maxLength: 500 = 500;

schema.properties.question.minLength

readonly minLength: 1 = 1;

schema.properties.question.type

readonly type: "string" = 'string';

schema.required

readonly required: readonly ["question", "options"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Poll" = 'Poll';

On this page