Interface ObjectMapping

Represents the mappings from a document to an anonymous object type.

Hierarchy

Mapping
- ObjectMapping
  - ClassMapping

Index

Properties

flags

Methods

Properties

flags

flags: MappingFlags

Readonly flags that describe the mapping. This value is assigned internally and should not be modified.

Methods

addProperty

addProperty(property: Property): void

- Defined in mapping/mappingModel.ts:216
Parameters
- property: Property
Returns void

getProperty

getProperty(name: string): Property

- Defined in mapping/mappingModel.ts:217
Parameters
- name: string
Returns Property

hasFlags

hasFlags(flags: MappingFlags): boolean

Inherited from Mapping.hasFlags
- Defined in mapping/mappingModel.ts:36
Returns true if the mapping has the specified flags; otherwise, returns false.

Parameters
- flags: MappingFlags
Returns boolean

validateProperty

validateProperty(property: Property): string

- Defined in mapping/mappingModel.ts:223
Validates a property before adding it to the mapping. Returns any validation error messages or undefined if none.

Parameters
- property: Property
  
  The property to validate.
Returns string

The error message.

Generated using TypeDoc