ApiSchemasVariables
Variable: order
const order: object & Typed<{
items: readonly object[];
note?: string;
respondingTo?: string;
total?: {
amount: string;
currency: string;
};
}>;Defined in: packages/core/src/schemas/library/money.ts:148
An order for listings. Only the buyer changes it; the seller answers with
std.order-updates, so the two never edit the same record.
Type Declaration
description
readonly description: "An order for things listed: what, how many, for how much." = 'An order for things listed: what, how many, for how much.';links
readonly links: object;links.about
readonly about: LinkDeclaration;name
readonly name: "std.order" = 'std.order';schema
readonly schema: object;schema.properties
readonly properties: object;schema.properties.items
readonly items: object;schema.properties.items.items
readonly items: object;schema.properties.items.items.properties
readonly properties: object;schema.properties.items.items.properties.price
readonly price: object & object;Type Declaration
properties
properties: object;properties.amount
amount: object;properties.amount.maxLength
maxLength: ... = max;properties.amount.minLength?
minLength?: ... = min;properties.amount.type
type: ...;properties.currency
currency: object;properties.currency.maxLength
maxLength: ... = 3;properties.currency.minLength
minLength: ... = 3;properties.currency.type
type: ...;required
required: readonly ["amount", "currency"];type
type: "object";x-kind
readonly "x-kind": "money";schema.properties.items.items.properties.quantity
readonly quantity: object;schema.properties.items.items.properties.quantity.maximum?
maximum?: number = max;schema.properties.items.items.properties.quantity.minimum
minimum: number = min;schema.properties.items.items.properties.quantity.type
type: "integer";schema.properties.items.items.properties.title
readonly title: object;schema.properties.items.items.properties.title.maxLength
maxLength: number = max;schema.properties.items.items.properties.title.minLength?
minLength?: number = min;schema.properties.items.items.properties.title.type
type: "string";schema.properties.items.items.required
readonly required: readonly ["title", "quantity"];schema.properties.items.items.type
readonly type: "object" = 'object';schema.properties.items.maxItems
readonly maxItems: 100 = 100;schema.properties.items.minItems
readonly minItems: 1 = 1;schema.properties.items.type
readonly type: "array" = 'array';schema.properties.note
readonly note: object;schema.properties.note.maxLength
maxLength: number = max;schema.properties.note.minLength?
minLength?: number = min;schema.properties.note.type
type: "string";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.total
readonly total: object & object;Type Declaration
properties
properties: object;properties.amount
amount: object;properties.amount.maxLength
maxLength: number = max;properties.amount.minLength?
minLength?: number = min;properties.amount.type
type: "string";properties.currency
currency: object;properties.currency.maxLength
maxLength: number = 3;properties.currency.minLength
minLength: number = 3;properties.currency.type
type: "string";required
required: readonly ["amount", "currency"];type
type: "object";x-kind
readonly "x-kind": "money";schema.required
readonly required: readonly ["items"];schema.type
readonly type: "object" = 'object';title
readonly title: "Order" = 'Order';topics
readonly topics: readonly ["respondingTo"];