@appsemble/lang-sdk/schemas/json/JSONSchemaEnum.js

Language SDK for Appsemble

import { BaseJSONSchema } from './BaseJSONSchema.js';
import { extendJSONSchema } from '../utils/extendJSONSchema.js';
export const JSONSchemaEnum = extendJSONSchema(BaseJSONSchema, {
    type: 'object',
    description: 'A JSON schema for an enum.',
    additionalProperties: false,
    required: ['enum'],
    properties: {
        enum: {
            type: 'array',
            description: 'A specific set of values this property is allowed to have.',
            items: {
                anyOf: [{ type: 'boolean' }, { type: 'number' }, { type: 'string' }, { enum: [null] }],
            },
        },
        enumDescriptions: {
            type: 'array',
            description: `An array is descriptions for the enum values.

The description is applied to the enum value at the same index.`,
            items: { type: 'string' },
        },
        examples: {
            type: 'array',
            items: {
                anyOf: [{ type: 'boolean' }, { type: 'number' }, { type: 'string' }, { enum: [null] }],
                description: 'An example which is valid according to this schema.',
            },
        },
        default: {
            anyOf: [{ type: 'boolean' }, { type: 'number' }, { type: 'string' }, { enum: [null] }],
            description: 'The default value which is used if no value is supplied.',
        },
    },
});
//# sourceMappingURL=JSONSchemaEnum.js.map