Elasticsearch Store: `Utils Model`
Table of contents
Variables
Functions
Variables
schema
• Const
schema: Object
JSON Schema
Type declaration
Name | Type |
---|---|
additionalProperties | boolean |
properties | { _created : { format : string = 'date-time' } ; _deleted : { default : boolean = false; type : string = 'boolean' } ; _key : { type : string = 'string' } ; _updated : { format : string = 'date-time' } ; client_id : { default : number = 1; minimum : number = 0; multipleOf : number = 1.0; type : string = 'number' } } |
properties._created | { format : string = 'date-time' } |
properties._created.format | string |
properties._deleted | { default : boolean = false; type : string = 'boolean' } |
properties._deleted.default | boolean |
properties._deleted.type | string |
properties._key | { type : string = 'string' } |
properties._key.type | string |
properties._updated | { format : string = 'date-time' } |
properties._updated.format | string |
properties.client_id | { default : number = 1; minimum : number = 0; multipleOf : number = 1.0; type : string = 'number' } |
properties.client_id.default | number |
properties.client_id.minimum | number |
properties.client_id.multipleOf | number |
properties.client_id.type | string |
required | string [] |
Defined in
elasticsearch-store/src/utils/model.ts:6
Functions
addDefaultSchema
▸ addDefaultSchema(input
): Record
<string
, any
>
Parameters
Name | Type |
---|---|
input | Record <string , any > |
Returns
Record
<string
, any
>
Defined in
elasticsearch-store/src/utils/model.ts:50
makeRecordDataType
▸ makeRecordDataType(arg
): DataType
Parameters
Name | Type |
---|---|
arg | Object |
arg.description? | string |
arg.fields | DataTypeFields |
arg.name | string |
Returns
DataType
Defined in
elasticsearch-store/src/utils/model.ts:32
mergeDefaults
▸ mergeDefaults<T
>(source
, from
): T
Deep copy two levels deep (useful for mapping and schema)
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
source | T |
from | Partial <T > |
Returns
T
Defined in
elasticsearch-store/src/utils/model.ts:57
toInstanceName
▸ toInstanceName(name
): string
Parameters
Name | Type |
---|---|
name | string |
Returns
string
Defined in
elasticsearch-store/src/utils/model.ts:76
uniqueFieldQuery
▸ uniqueFieldQuery(field
): string
Parameters
Name | Type |
---|---|
field | string |
Returns
string