minca
ApiSchemasVariables

Variable: badge

const badge: object & Typed<{
  description?: string;
  image?: {
     hash: string;
     key?: string;
     mime: string;
     name?: string;
     salt?: string;
     size: number;
  };
  name: string;
}>;

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

A badge that can be awarded.

Type Declaration

description

readonly description: "A badge that people can be awarded." = 'A badge that people can be awarded.';

name

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

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.description

readonly description: object;

schema.properties.description.maxLength

maxLength: number = max;

schema.properties.description.minLength?

minLength?: number = min;

schema.properties.description.type

type: "string";

schema.properties.image

readonly image: 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.name

readonly name: object;

schema.properties.name.maxLength

maxLength: number = max;

schema.properties.name.minLength?

minLength?: number = min;

schema.properties.name.type

type: "string";

schema.required

readonly required: readonly ["name"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Badge" = 'Badge';

On this page