Stevan/onspring-api-sdk-javascript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: add js doc comments.

Browse Source
This commit is contained in:
StevanFreeborn
2023-02-05 15:32:22 -06:00
parent e6eae35e03
commit fac2367052
5 changed files with 142 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/models/ReferenceField.ts
+24
View File
@@ -1,10 +1,34 @@
import { Multiplicity } from '../enums/Multiplicity';
import { Field } from './Field';
/**
* @class ReferenceField - Represents a reference field.
*/
export class ReferenceField extends Field {
/**
* @property {Multiplicity} multiplicity - The multiplicity of the reference field.
*/
public multiplicity: Multiplicity;
/**
* @property {number} referencedAppId - The id of the app the reference field references.
*/
public referencedAppId: number;
/**
* @constructor - Creates a new ReferenceField.
* @param {number} id - The id of the reference field.
* @param {number} appId - The id of the app the reference field belongs to.
* @param {string} name - The name of the reference field.
* @param {string} type - The type of the reference field.
* @param {string} status - The status of the reference field.
* @param {boolean} isRequired - Whether the reference field is required.
* @param {boolean} isUnique - Whether the reference field is unique.
* @param {string} multiplicity - The multiplicity of the reference field.
* @param {number} referencedAppId - The id of the app the reference field references.
* @returns {ReferenceField} - A new ReferenceField.
* @throws {Error} - Throws an error if the multiplicity is not a valid Multiplicity.jjkdleroritlasaxmvjd
*/
constructor(
id: number,
appId: number,