@siren-js/client/dist/models/field.js

Siren API client library

var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
    return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __metadata = (this && this.__metadata) || function (k, v) {
    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
};
import { IsArray, IsOptional, IsString } from 'class-validator';
/**
 * Represents an input control inside an `Action`. Serialization of a `Field` depends on its `type` and its
 * corresponding `Action`'s `type`.
 * @typeParam T Type of the `value` property.
 */
export class Field {
    /**
     * List of strings describing the nature of the `Field` based on the current representation. Possible values are
     * implementation-dependent and should be documented.
     */
    class = [];
    /**
     * Name describing the control. Must be unique within an `Action`.
     */
    name;
    /**
     * Textual annotation of a field. Clients may use this as a label.
     */
    title;
    /**
     * Input type of the field. May include any of the [input types from HTML](https://html.spec.whatwg.org/multipage/input.html#attr-input-type).
     * When missing, the default is assumed to be `text`.
     */
    type = 'text';
    /**
     * Value assigned to the `Field`.
     */
    value;
    /**
     * Visits this field.
     */
    async accept(visitor) {
        await visitor.visitField(this);
    }
}
__decorate([
    IsArray(),
    IsString({ each: true }),
    IsOptional(),
    __metadata("design:type", Array)
], Field.prototype, "class", void 0);
__decorate([
    IsString(),
    __metadata("design:type", String)
], Field.prototype, "name", void 0);
__decorate([
    IsString(),
    IsOptional(),
    __metadata("design:type", String)
], Field.prototype, "title", void 0);
__decorate([
    IsString(),
    IsOptional(),
    __metadata("design:type", Object)
], Field.prototype, "type", void 0);
__decorate([
    IsOptional(),
    __metadata("design:type", Object)
], Field.prototype, "value", void 0);