elasticsearch-store / utils/model

utils/model

Variables

schema

const schema: object

Defined in: utils/model.ts:10

JSON Schema

Type Declaration

additionalProperties

additionalProperties: boolean = false

properties

properties: object

properties._created

_created: object

properties._created.format

format: string = 'date-time'

properties._created.type

type: string = 'string'

properties._deleted

_deleted: object

properties._deleted.default

default: boolean = false

properties._deleted.type

type: string = 'boolean'

properties._key

_key: object

properties._key.type

type: string = 'string'

properties._updated

_updated: object

properties._updated.format

format: string = 'date-time'

properties._updated.type

type: string = 'string'

properties.client_id

client_id: object

properties.client_id.default

default: number = 1

properties.client_id.minimum

minimum: number = 0

properties.client_id.multipleOf

multipleOf: number = 1.0

properties.client_id.type

type: string = 'number'

required

required: string[]

type

type: string = 'object'

Functions

addDefaultSchema()

addDefaultSchema(input): Record<string, any>

Defined in: utils/model.ts:57

Parameters

Parameter	Type
input	Record<string, any>

Returns

Record<string, any>

---

makeRecordDataType()

makeRecordDataType(arg): DataType

Defined in: utils/model.ts:39

Parameters

Parameter	Type
arg	{ description?: string; fields: DataTypeFields; name: string; }
arg.description?	string
arg.fields	DataTypeFields
arg.name	string

Returns

DataType

---

mergeDefaults()

mergeDefaults<T>(source, from): T

Defined in: utils/model.ts:64

Deep copy two levels deep (useful for mapping and schema)

Type Parameters

Type Parameter
T extends object

Parameters

Parameter	Type
source	T
from	Partial<T>

Returns

T

---

toInstanceName()

toInstanceName(name): string

Defined in: utils/model.ts:83

Parameters

Parameter	Type
name	string

Returns

string

---

uniqueFieldQuery()

uniqueFieldQuery(field): string

Defined in: utils/model.ts:89

Parameters

Parameter	Type
field	string

Returns

string