Elasticsearch Store: `Utils Validation`
Table of contents
Functions
- isTemplatedIndex
- isTimeSeriesIndex
- isValidClient
- isValidName
- isValidNamespace
- makeDataValidator
- validateId
- validateIds
- validateIndexConfig
Functions
isTemplatedIndex
▸ isTemplatedIndex(config?
): boolean
Parameters
Name | Type |
---|---|
config? | IndexSchema |
Returns
boolean
Defined in
elasticsearch-store/src/utils/validation.ts:123
isTimeSeriesIndex
▸ isTimeSeriesIndex(config?
): boolean
Parameters
Name | Type |
---|---|
config? | IndexSchema |
Returns
boolean
Defined in
elasticsearch-store/src/utils/validation.ts:127
isValidClient
▸ isValidClient(input
): input is Client
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is Client
Defined in
elasticsearch-store/src/utils/validation.ts:114
isValidName
▸ isValidName(name
): boolean
Parameters
Name | Type |
---|---|
name | string |
Returns
boolean
Defined in
elasticsearch-store/src/utils/validation.ts:7
isValidNamespace
▸ isValidNamespace(namespace
): boolean
Parameters
Name | Type |
---|---|
namespace | string |
Returns
boolean
Defined in
elasticsearch-store/src/utils/validation.ts:31
makeDataValidator
▸ makeDataValidator(dataSchema
, logger
): (input
: any
, critical
: boolean
) => any
Parameters
Name | Type |
---|---|
dataSchema | DataSchema |
logger | Logger |
Returns
fn
▸ (input
, critical
): any
Parameters
Name | Type |
---|---|
input | any |
critical | boolean |
Returns
any
Defined in
elasticsearch-store/src/utils/validation.ts:36
validateId
▸ validateId(id
, action
, throwError?
): id is string
Parameters
Name | Type | Default value |
---|---|---|
id | unknown | undefined |
action | string | undefined |
throwError | boolean | true |
Returns
id is string
Defined in
elasticsearch-store/src/utils/validation.ts:11
validateIds
▸ validateIds(ids
, action
): string
[]
Parameters
Name | Type |
---|---|
ids | unknown |
action | string |
Returns
string
[]
Defined in
elasticsearch-store/src/utils/validation.ts:27
validateIndexConfig
▸ validateIndexConfig(config
): config is IndexConfig<any>
Parameters
Name | Type |
---|---|
config | Record <string , any > |
Returns
config is IndexConfig<any>