minca
ApiSchemasVariables

Variable: vote

const vote: object & Typed<{
  choice: number;
  choices?: readonly number[];
  respondingTo?: string;
}>;

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

One person's vote on a poll or proposal: the position of their choice in its options. For more than one choice, or a ranking, choices lists them in order and choice is the first. One per person per poll — voting again changes it; deleting takes it back.

Type Declaration

description

readonly description: "One person’s vote on a std.poll, changed by voting again. To vote on a std.proposal, use std.ballot: it is final and counts toward a decision." = 'One person’s vote on a std.poll, changed by voting again. To vote on a std.proposal, use std.ballot: it is final and counts toward a decision.';
readonly links: object;

links.about

readonly about: LinkDeclaration;

name

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

rules

readonly rules: object;

rules.onePer

readonly onePer: readonly ["@author", "link:about"];

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.choice

readonly choice: object;

schema.properties.choice.minimum

readonly minimum: 0 = 0;

schema.properties.choice.type

readonly type: "integer" = 'integer';

schema.properties.choice.x-choicesFrom

readonly "x-choicesFrom": object;

schema.properties.choice.x-choicesFrom.field

readonly field: "options" = 'options';

schema.properties.choice.x-choicesFrom.rel

readonly rel: "about" = 'about';

schema.properties.choices

readonly choices: object;

schema.properties.choices.description

readonly description: "Every choice, most preferred first, when there are several" = 'Every choice, most preferred first, when there are several';

schema.properties.choices.items

readonly items: object;

schema.properties.choices.items.minimum

readonly minimum: 0 = 0;

schema.properties.choices.items.type

readonly type: "integer" = 'integer';

schema.properties.choices.items.x-choicesFrom

readonly "x-choicesFrom": object;

schema.properties.choices.items.x-choicesFrom.field

readonly field: "options" = 'options';

schema.properties.choices.items.x-choicesFrom.rel

readonly rel: "about" = 'about';

schema.properties.choices.maxItems

readonly maxItems: 100 = 100;

schema.properties.choices.type

readonly type: "array" = 'array';

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

readonly required: readonly ["choice"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Vote" = 'Vote';

topics

readonly topics: readonly ["respondingTo"];

On this page