minca
ApiSchemasVariables

Variable: workout

const workout: object & Typed<{
  distance?: number;
  duration?: number;
  note?: string;
  route?: {
     hash: string;
     key?: string;
     mime: string;
     name?: string;
     salt?: string;
     size: number;
  };
  start: string;
  type: string;
}>;

Defined in: packages/core/src/schemas/library/life.ts:170

A workout: a run, a ride, a session at the gym.

Type Declaration

description

readonly description: "A run, a ride, a session: when, how long, how far." = 'A run, a ride, a session: when, how long, how far.';

name

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

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.distance

readonly distance: object;

schema.properties.distance.description

readonly description: "Metres" = 'Metres';

schema.properties.distance.minimum

readonly minimum: 0 = 0;

schema.properties.distance.type

readonly type: "number" = 'number';

schema.properties.duration

readonly duration: object;

schema.properties.duration.description

readonly description: "Seconds" = 'Seconds';

schema.properties.duration.minimum

readonly minimum: 0 = 0;

schema.properties.duration.type

readonly type: "number" = 'number';

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

readonly route: 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.start

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

schema.properties.type

readonly type: object;

schema.properties.type.maxLength

maxLength: number = max;

schema.properties.type.minLength?

minLength?: number = min;

schema.properties.type.type

type: "string";

schema.required

readonly required: readonly ["type", "start"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Workout" = 'Workout';

On this page