minca
ApiSchemasVariables

Variable: article

const article: object & Typed<{
  content?: string;
  cover?: {
     hash: string;
     key?: string;
     mime: string;
     name?: string;
     salt?: string;
     size: number;
  };
  draft?: boolean;
  mentions?: readonly string[];
  publishedAt?: string;
  slug?: string;
  summary?: string;
  title: string;
}>;

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

Long-form writing, optionally in a publication. draft keeps it unlisted.

Type Declaration

description

readonly description: "Long-form writing, in CommonMark." = 'Long-form writing, in CommonMark.';
readonly links: object;

links.in

readonly in: LinkDeclaration;

name

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

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.content

readonly content: object;

schema.properties.content.maxLength

maxLength: number = max;

schema.properties.content.minLength?

minLength?: number = min;

schema.properties.content.type

type: "string";

schema.properties.cover

readonly cover: object & object;
Type Declaration
properties
properties: object;
properties.hash
hash: object;
properties.hash.maxLength
maxLength: number = 64;
properties.hash.minLength
minLength: number = 64;
properties.hash.type
type: "string";
properties.key
key: object;
properties.key.maxLength
maxLength: number = 22;
properties.key.minLength
minLength: number = 22;
properties.key.type
type: "string";
properties.mime
mime: object;
properties.mime.maxLength
maxLength: number = max;
properties.mime.minLength?
minLength?: number = min;
properties.mime.type
type: "string";
properties.name
name: object;
properties.name.maxLength
maxLength: number = max;
properties.name.minLength?
minLength?: number = min;
properties.name.type
type: "string";
properties.salt
salt: object;
properties.salt.maxLength
maxLength: number = 22;
properties.salt.minLength
minLength: number = 22;
properties.salt.type
type: "string";
properties.size
size: object;
properties.size.minimum
minimum: number = 0;
properties.size.type
type: "integer";
required
required: readonly ["hash", "size", "mime"];
type
type: "object";
x-kind
readonly "x-kind": "file";

schema.properties.draft

readonly draft: object;

schema.properties.draft.type

readonly type: "boolean" = 'boolean';

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

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

schema.properties.slug

readonly slug: object;

schema.properties.slug.maxLength

maxLength: number = max;

schema.properties.slug.minLength?

minLength?: number = min;

schema.properties.slug.type

type: "string";

schema.properties.summary

readonly summary: object;

schema.properties.summary.maxLength

maxLength: number = max;

schema.properties.summary.minLength?

minLength?: number = min;

schema.properties.summary.type

type: "string";

schema.properties.title

readonly title: object;

schema.properties.title.maxLength

maxLength: number = max;

schema.properties.title.minLength?

minLength?: number = min;

schema.properties.title.type

type: "string";

schema.required

readonly required: readonly ["title"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Article" = 'Article';

topics

readonly topics: readonly ["mentions"];

On this page