fix: corrected JSDoc comments
This commit is contained in:
@@ -1,15 +1,58 @@
|
||||
import { FieldStatus } from '../enums/FieldStatus';
|
||||
import { FieldType } from '../enums/FieldType';
|
||||
|
||||
/**
|
||||
* @class Field - Represents a Field.
|
||||
*/
|
||||
export class Field {
|
||||
/**
|
||||
* @property {number} id - The id of the Field.
|
||||
*/
|
||||
public id: number;
|
||||
|
||||
/**
|
||||
* @property {number} appId - The id of the App that the Field belongs to.
|
||||
*/
|
||||
public appId: number;
|
||||
|
||||
/**
|
||||
* @property {number} name - The name of the Field.
|
||||
*/
|
||||
public name: string;
|
||||
|
||||
/**
|
||||
* @property {FieldType} type - The type of the Field.
|
||||
*/
|
||||
public type: FieldType;
|
||||
|
||||
/**
|
||||
* @property {FieldStatus} status - The status of the Field.
|
||||
*/
|
||||
public status: FieldStatus;
|
||||
|
||||
/**
|
||||
* @property {boolean} isRequired - Indicates whether or not the Field is required.
|
||||
*/
|
||||
public isRequired: boolean;
|
||||
|
||||
/**
|
||||
* @property {boolean} isUnique - Indicates whether or not the Field is required to be unique.
|
||||
*/
|
||||
public isUnique: boolean;
|
||||
|
||||
/**
|
||||
* @constructor - Creates a new Field.
|
||||
* @param {number} id - The id of the Field.
|
||||
* @param {number} appId - The id of the App that the Field belongs to.
|
||||
* @param {string} name - The name of the Field.
|
||||
* @param {string} type - The type of the Field.
|
||||
* @param {string} status - The status of the Field.
|
||||
* @param {boolean} isRequired - Indicates whether or not the Field is required.
|
||||
* @param {boolean} isUnique - Indicates whether or not the Field is required to be unique.
|
||||
* @returns {Field} - A new Field.
|
||||
* @throws {Error} - Throws an error if the type is not valid.
|
||||
* @throws {Error} - Throws an error if the status is not valid.
|
||||
*/
|
||||
public constructor(
|
||||
id: number,
|
||||
appId: number,
|
||||
|
||||
Reference in New Issue
Block a user