@barchart/common-js/types/serialization/json/Field.d.ts

Library of common JavaScript utilities

/**
 * A simple field.
 *
 * @public
 */
export default class Field {
    /**
     * @param {string} name
     * @param {DataType} dataType
     * @param {boolean=} optional
     * @param {boolean=} array
     */
    constructor(name: string, dataType: DataType, optional?: boolean | undefined, array?: boolean | undefined);
    /**
     * Name of the field.
     *
     * @public
     * @returns {string}
     */
    public get name(): string;
    /**
     * Type of the field.
     *
     * @public
     * @returns {DataType}
     */
    public get dataType(): DataType;
    /**
     * Indicates if the field can be omitted without violating the schema.
     *
     * @public
     * @returns {boolean}
     */
    public get optional(): boolean;
    /**
     * Indicates if the field is an array.
     *
     * @public
     * @returns {boolean}
     */
    public get array(): boolean;
    /**
     * Returns a string representation.
     *
     * @public
     * @returns {string}
     */
    public toString(): string;
    #private;
}
import DataType from './DataType.js';