Class DataParserBase<parserRule>`Abstract`

define a parser

Example

// define a parser which parser A to ATarget
class AParser extends DataParserBase<AParserRule> { }

Type Parameters

parserRule extends ParserRule

Hierarchy

DataParserBase

Index

Constructors

constructor

new DataParserBase<parserRule>(oriDataType: ConstructorType<parserRule["oriObjectType"]>): DataParserBase<parserRule>
Type Parameters
- parserRule extends ParserRule<Object, Record<string, any>, any, DataParserBase<any>>
Parameters
- oriDataType: ConstructorType<parserRule["oriObjectType"]>
Returns DataParserBase<parserRule>
- Defined in index.ts:56

Properties

`Readonly` oriObjectType

oriObjectType: ConstructorType<parserRule["oriObjectType"]>

`Static` `Private` gettersCache

gettersCache: Map<DataParserBase<any>, any> = ...

`Static` `Private` settersCache

settersCache: Map<DataParserBase<any>, any> = ...

Accessors

`Abstract` propertyGetters

get propertyGetters(): { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], propertyName: string) => parserRule["targetDataType"][P]) }
Returns { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], propertyName: string) => parserRule["targetDataType"][P]) }
- Defined in index.ts:61

`Abstract` propertySetters

get propertySetters(): { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], targetValue: parserRule["targetDataType"][P], propertyName?: string, exData?: parserRule["exDataType"], callback?: (() => void)) => void) }
Returns { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], targetValue: parserRule["targetDataType"][P], propertyName?: string, exData?: parserRule["exDataType"], callback?: (() => void)) => void) }
- Defined in index.ts:72

Methods

get

get<PropertyNames>(value: parserRule["oriObjectType"], ...propertyNames: PropertyNames): PropertyNames extends [] ? parserRule["targetDataType"] : Pick<parserRule["targetDataType"], PropertyNames[number]>
get property value

Returns
property value
Type Parameters
- PropertyNames extends Extract<keyof parserRule["targetDataType"], string>[]
Parameters
- value: parserRule["oriObjectType"]
  
  original data
- Rest ...propertyNames: PropertyNames
  
  property names,can be null
Returns PropertyNames extends [] ? parserRule["targetDataType"] : Pick<parserRule["targetDataType"], PropertyNames[number]>
- Defined in index.ts:88

`Protected` initGetters

initGetters<T>(getterDescription: T): T
Type Parameters
- T extends { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], propertyName: string) => parserRule["targetDataType"][P]) }
Parameters
- getterDescription: T
Returns T
- Defined in index.ts:62

`Protected` initSetters

initSetters<T>(setterDescription: T): T
Type Parameters
- T extends { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], targetValue: parserRule["targetDataType"][P], propertyName?: string, exData?: parserRule["exDataType"], callback?: (() => void)) => void) }
Parameters
- setterDescription: T
Returns T
- Defined in index.ts:73

set

set(value: parserRule["oriObjectType"], partialTargetData: Partial<parserRule["targetDataType"]>, extras?: { callback?: (() => void); exData?: parserRule["exDataType"] }): void
set property value
Parameters
- value: parserRule["oriObjectType"]
  
  original data
- partialTargetData: Partial<parserRule["targetDataType"]>
  
  propertyName-propertyValue key pairs
- Optional extras: { callback?: (() => void); exData?: parserRule["exDataType"] }
  
  extras data,which is helpful when we want to do something else after the property is been set
  - Optional callback?: (() => void)
    - (): void
      
      Returns void
  - Optional exData?: parserRule["exDataType"]
Returns void
- Defined in index.ts:126

Class DataParserBase<parserRule>Abstract

Example

Type Parameters

parserRule extends ParserRule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

parserRule extends ParserRule<Object, Record<string, any>, any, DataParserBase<any>>

Parameters

oriDataType: ConstructorType<parserRule["oriObjectType"]>

Returns DataParserBase<parserRule>

Properties

Readonly oriObjectType

Static Private gettersCache

Static Private settersCache

Accessors

Abstract propertyGetters

Returns { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], propertyName: string) => parserRule["targetDataType"][P]) }

Abstract propertySetters

Returns { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], targetValue: parserRule["targetDataType"][P], propertyName?: string, exData?: parserRule["exDataType"], callback?: (() => void)) => void) }

Methods

get

Returns

Type Parameters

PropertyNames extends Extract<keyof parserRule["targetDataType"], string>[]

Parameters

value: parserRule["oriObjectType"]

Rest ...propertyNames: PropertyNames

Returns PropertyNames extends [] ? parserRule["targetDataType"] : Pick<parserRule["targetDataType"], PropertyNames[number]>

Protected initGetters

Type Parameters

T extends { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], propertyName: string) => parserRule["targetDataType"][P]) }

Parameters

getterDescription: T

Returns T

Protected initSetters

Type Parameters

T extends { [ P in string | number | symbol]: ((value: parserRule["oriObjectType"], targetValue: parserRule["targetDataType"][P], propertyName?: string, exData?: parserRule["exDataType"], callback?: (() => void)) => void) }

Parameters

setterDescription: T

Returns T

set

Parameters

value: parserRule["oriObjectType"]

partialTargetData: Partial<parserRule["targetDataType"]>

Optional extras: { callback?: (() => void); exData?: parserRule["exDataType"] }

Optional callback?: (() => void)

Returns void

Optional exData?: parserRule["exDataType"]

Returns void

Settings

Member Visibility

Theme

Class DataParserBase<parserRule>`Abstract`

`Readonly` oriObjectType

`Static` `Private` gettersCache

`Static` `Private` settersCache

`Abstract` propertyGetters

`Abstract` propertySetters

`Rest` ...propertyNames: PropertyNames

`Protected` initGetters

`Protected` initSetters

`Optional` extras: { callback?: (() => void); exData?: parserRule["exDataType"] }

`Optional` callback?: (() => void)

`Optional` exData?: parserRule["exDataType"]