yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-10-30 10:14:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

minor jsdoc housekeeping in datasets/compliance.ts

Browse Source
This commit is contained in:
Seyi Adebajo 2017-10-14 14:52:54 -07:00
parent 36c83e123d
commit 086101464c
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
wherehows-web/app/constants/datasets/compliance.ts
View File

@ -16,7 +16,7 @@ enum Classification {
} }
/** /**
* Defines the string values for an id logical tyoe * Defines the string values for an id logical type
* @enum {string} * @enum {string}
*/ */
enum IdLogicalType { enum IdLogicalType {
@ -74,6 +74,7 @@ interface INonIdLogicalTypesSignature {
/** /**
* Describes the properties on a field identifier object for ui rendering * Describes the properties on a field identifier object for ui rendering
* @interface IFieldIdProps
*/ */
interface IFieldIdProps { interface IFieldIdProps {
value: string; value: string;
@ -83,6 +84,7 @@ interface IFieldIdProps {
/** /**
* Describes the index signature for fieldIdentifierTypes * Describes the index signature for fieldIdentifierTypes
* @interface IFieldIdTypes
*/ */
interface IFieldIdTypes { interface IFieldIdTypes {
[prop: string]: IFieldIdProps; [prop: string]: IFieldIdProps;
@ -90,19 +92,19 @@ interface IFieldIdTypes {
/** /**
* A list of id logical types * A list of id logical types
* @type {Array.<String>} * @type {Array<IdLogicalType>}
*/ */
const idLogicalTypes = Object.values(IdLogicalType).sort() as Array<IdLogicalType>; const idLogicalTypes = Object.values(IdLogicalType).sort() as Array<IdLogicalType>;
/** /**
* A list of custom logical types that may be treated ids but have a different behaviour from regular ids * A list of custom logical types that may be treated ids but have a different behaviour from regular ids
* @type {Array.<String>} * @type {Array<CustomIdLogicalType>}
*/ */
const customIdLogicalTypes = Object.values(CustomIdLogicalType) as Array<CustomIdLogicalType>; const customIdLogicalTypes = Object.values(CustomIdLogicalType) as Array<CustomIdLogicalType>;
/** /**
* List of non Id field data type classifications * List of non Id field data type classifications
* @type {Array} * @type {Array<NonIdLogicalType>}
*/ */
const genericLogicalTypes = Object.values(NonIdLogicalType).sort() as Array<NonIdLogicalType>; const genericLogicalTypes = Object.values(NonIdLogicalType).sort() as Array<NonIdLogicalType>;