elasticsearch-store / utils/validation

utils/validation

Functions

isTemplatedIndex()

isTemplatedIndex(config?): boolean

Defined in: elasticsearch-store/src/utils/validation.ts:128

Parameters

Parameter	Type
config?	IndexSchema

Returns

boolean

---

isTimeSeriesIndex()

isTimeSeriesIndex(config?): boolean

Defined in: elasticsearch-store/src/utils/validation.ts:132

Parameters

Parameter	Type
config?	IndexSchema

Returns

boolean

---

isValidClient()

isValidClient(input): input is Client

Defined in: elasticsearch-store/src/utils/validation.ts:119

Parameters

Parameter	Type
input	unknown

Returns

input is Client

---

isValidName()

isValidName(name): boolean

Defined in: elasticsearch-store/src/utils/validation.ts:12

Parameters

Parameter	Type
name	string

Returns

boolean

---

isValidNamespace()

isValidNamespace(namespace): boolean

Defined in: elasticsearch-store/src/utils/validation.ts:36

Parameters

Parameter	Type
namespace	string

Returns

boolean

---

makeDataValidator()

makeDataValidator(dataSchema, logger): (input, critical) => any

Defined in: elasticsearch-store/src/utils/validation.ts:41

Parameters

Parameter	Type
dataSchema	DataSchema
logger	Logger

Returns

Function

Parameters

Parameter	Type
input	any
critical	boolean

Returns

any

---

validateId()

validateId(id, action, throwError): id is string

Defined in: elasticsearch-store/src/utils/validation.ts:16

Parameters

Parameter	Type	Default value
id	unknown	undefined
action	string	undefined
throwError	boolean	true

Returns

id is string

---

validateIds()

validateIds(ids, action): string[]

Defined in: elasticsearch-store/src/utils/validation.ts:32

Parameters

Parameter	Type
ids	unknown
action	string

Returns

string[]

---

validateIndexConfig()

validateIndexConfig(config): config is IndexConfig<any>

Defined in: elasticsearch-store/src/utils/validation.ts:76

Parameters

Parameter	Type
config	Record<string, any>

Returns

config is IndexConfig<any>