@siren-js/core/dist/Field.d.ts

Cross-platform library of classes for generating and parsing Siren entities

/**
 * Represents an input control inside an `Action`. Serialization of a `Field` depends on its `type` and its
 * corresponding `Action`'s `type`.
 */
export declare class Field<T = unknown> {
    /**
     * List of strings describing the nature of the `Field` based on the current representation. Possible values are
     * implementation-dependent and should be documented.
     */
    class?: string[];
    /**
     * Name describing the control. Must be unique within an `Action`.
     */
    name: string;
    /**
     * Textual annotation of a field. Clients may use this as a label.
     */
    title?: string;
    /**
     * 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?: string;
    /**
     * Value assigned to the `Field`.
     */
    value?: T;
    [extension: string]: unknown;
    static of(field: Field): Field;
}