ApiSchemasVariables
Variable: profile
const profile: object & Typed<{
avatar?: {
hash: string;
key?: string;
mime: string;
name?: string;
salt?: string;
size: number;
};
banner?: {
hash: string;
key?: string;
mime: string;
name?: string;
salt?: string;
size: number;
};
bio?: string;
bot?: boolean;
links?: readonly object[];
name?: string;
pronouns?: string;
}>;Defined in: packages/core/src/schemas/library/social.ts:17
How someone presents themselves: more than the name every space keeps for
them (sys.profile). One per person, and only theirs to write.
bot is the account saying it is software someone runs, not a person, so
apps can show it. It is the account's own word, like the rest: an honest
operator discloses with it, and it proves nothing about anyone who doesn't.
Type Declaration
description
readonly description: "How someone presents themselves: one per person." = 'How someone presents themselves: one per person.';name
readonly name: "std.profile" = 'std.profile';rules
readonly rules: object;rules.onePer
readonly onePer: readonly ["@author"];schema
readonly schema: object;schema.properties
readonly properties: object;schema.properties.avatar
readonly avatar: 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.banner
readonly banner: 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.bio
readonly bio: object;schema.properties.bio.maxLength
maxLength: number = max;schema.properties.bio.minLength?
minLength?: number = min;schema.properties.bio.type
type: "string";schema.properties.bot
readonly bot: object;schema.properties.bot.description
readonly description: "The account is software someone runs, not a person" = 'The account is software someone runs, not a person';schema.properties.bot.type
readonly type: "boolean" = 'boolean';schema.properties.links
readonly links: object;schema.properties.links.items
readonly items: object;schema.properties.links.items.properties
readonly properties: object;schema.properties.links.items.properties.title
readonly title: object;schema.properties.links.items.properties.title.maxLength
maxLength: number = max;schema.properties.links.items.properties.title.minLength?
minLength?: number = min;schema.properties.links.items.properties.title.type
type: "string";schema.properties.links.items.properties.url
readonly url: object & object;Type Declaration
maxLength
maxLength: number = max;minLength?
minLength?: number = min;type
type: "string";x-kind
readonly "x-kind": "url";schema.properties.links.items.required
readonly required: readonly ["url"];schema.properties.links.items.type
readonly type: "object" = 'object';schema.properties.links.maxItems
readonly maxItems: 16 = 16;schema.properties.links.type
readonly type: "array" = 'array';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.properties.pronouns
readonly pronouns: object;schema.properties.pronouns.maxLength
maxLength: number = max;schema.properties.pronouns.minLength?
minLength?: number = min;schema.properties.pronouns.type
type: "string";schema.type
readonly type: "object" = 'object';title
readonly title: "Profile" = 'Profile';