@terascope/types / terafoundation

terafoundation

Interfaces

Interface	Description
ConnectionConfig	-
Connector	-
ConnectorOutput	-
Format	-
FoundationAPIs	-
FoundationWorker	-
PromMetrics	-
PromMetricsAPIConfig	-
PromMetricsInitConfig	-
SchemaObj	-
TerafoundationConfig	-

Type Aliases

Cluster

Cluster = Overwrite<NodeJSCluster, { workers: {[id: string]: FoundationWorker; }; fork: FoundationWorker; }>

Defined in: packages/types/src/terafoundation.ts:139

---

Config

Config<S, A, D> = object

Defined in: packages/types/src/terafoundation.ts:70

Type Parameters

Type Parameter	Default type
S	Record<string, any>
A	Record<string, any>
D extends string	string

Properties

cluster_name?

optional cluster_name: string | (sysconfig) => string

Defined in: packages/types/src/terafoundation.ts:79

config_schema?

optional config_schema: any

Defined in: packages/types/src/terafoundation.ts:76

default_config_file?

optional default_config_file: string

Defined in: packages/types/src/terafoundation.ts:78

descriptors?

optional descriptors: Record<D, string>

Defined in: packages/types/src/terafoundation.ts:81

master()?

optional master: (context, config) => void | Promise<void>

Defined in: packages/types/src/terafoundation.ts:82

Parameters

Parameter	Type
context	Context<S, A, D>
config	Config<S, A, D>

Returns

void | Promise<void>

name

name: string

Defined in: packages/types/src/terafoundation.ts:75

schema_formats?

optional schema_formats: Format[]

Defined in: packages/types/src/terafoundation.ts:77

script()?

optional script: (context) => void | Promise<void>

Defined in: packages/types/src/terafoundation.ts:80

Parameters

Parameter	Type
context	Context<S, A, D>

Returns

void | Promise<void>

shutdownMessaging?

optional shutdownMessaging: boolean

Defined in: packages/types/src/terafoundation.ts:90

start_workers?

optional start_workers: boolean

Defined in: packages/types/src/terafoundation.ts:89

worker()?

optional worker: (context) => void | Promise<void>

Defined in: packages/types/src/terafoundation.ts:86

Parameters

Parameter	Type
context	Context<S, A, D>

Returns

void | Promise<void>

---

Context

Context<S, A, D> = object

Defined in: packages/types/src/terafoundation.ts:163

Type Parameters

Type Parameter	Default type
S	Record<string, any>
A	Record<string, any>
D extends string	string

Properties

apis

apis: ContextAPIs & A

Defined in: packages/types/src/terafoundation.ts:169

arch

arch: string

Defined in: packages/types/src/terafoundation.ts:172

assignment

assignment: D

Defined in: packages/types/src/terafoundation.ts:174

cluster

cluster: Cluster

Defined in: packages/types/src/terafoundation.ts:176

cluster_name?

optional cluster_name: string

Defined in: packages/types/src/terafoundation.ts:175

logger

logger: Logger

Defined in: packages/types/src/terafoundation.ts:170

name

name: string

Defined in: packages/types/src/terafoundation.ts:171

platform

platform: string

Defined in: packages/types/src/terafoundation.ts:173

sysconfig

sysconfig: SysConfig<S>

Defined in: packages/types/src/terafoundation.ts:168

---

ContextAPIs

ContextAPIs = object

Defined in: packages/types/src/terafoundation.ts:121

Indexable

[namespace: string]: any

Properties

foundation

readonly foundation: FoundationAPIs

Defined in: packages/types/src/terafoundation.ts:122

Methods

registerAPI()

registerAPI(namespace, apis): void

Defined in: packages/types/src/terafoundation.ts:123

Parameters

Parameter	Type
namespace	string
apis	any

Returns

void

---

ConvictFormat

ConvictFormat = any[] | PredefinedFormat | FormatFn | Format

Defined in: packages/types/src/terafoundation.ts:32

---

CreateClientFactoryFn()

CreateClientFactoryFn = (config, logger, options) => Promise<ConnectorOutput>

Defined in: packages/types/src/terafoundation.ts:104

Parameters

Parameter	Type
config	Record<string, any>
logger	Logger
options	ConnectionConfig

Returns

Promise<ConnectorOutput>

---

Initializers

Initializers<S> = object

Defined in: packages/types/src/terafoundation.ts:54

Type Parameters

Type Parameter	Default type
S	Record<string, any>

Properties

schema

schema: Schema<S>

Defined in: packages/types/src/terafoundation.ts:55

validatorFn?

optional validatorFn: ValidatorFn<S>

Defined in: packages/types/src/terafoundation.ts:56

---

LogLevelConfig

LogLevelConfig = string | { [type in LogType]: LogLevelType }[]

Defined in: packages/types/src/terafoundation.ts:129

---

LogLevelType

LogLevelType = "trace" | "debug" | "info" | "warn" | "error" | "fatal"

Defined in: packages/types/src/terafoundation.ts:128

---

LogType

LogType = "console" | "file"

Defined in: packages/types/src/terafoundation.ts:127

---

MetricList

MetricList = Record<string, { functions?: Set<string>; metric?: Gauge<any> | Counter<any> | Histogram<any> | Summary<any>; name?: string; }>

Defined in: packages/types/src/terafoundation.ts:234

---

Schema

Schema<T> = { [P in keyof T]: Schema<T[P]> | SchemaObj<T[P]> }

Defined in: packages/types/src/terafoundation.ts:28

Type Parameters

Type Parameter
T

---

SysConfig

SysConfig<S> = object & S

Defined in: packages/types/src/terafoundation.ts:158

Type Declaration

_nodeName

_nodeName: string

terafoundation

terafoundation: TerafoundationConfig

Type Parameters

Type Parameter
S

---

ValidationObj

ValidationObj<S> = object

Defined in: packages/types/src/terafoundation.ts:59

Type Parameters

Type Parameter
S

Properties

config

config: Record<string, any>

Defined in: packages/types/src/terafoundation.ts:60

connector?

optional connector: boolean

Defined in: packages/types/src/terafoundation.ts:62

validatorFn?

optional validatorFn: ValidatorFn<S>

Defined in: packages/types/src/terafoundation.ts:61

---

ValidatorFn()

ValidatorFn<S> = (config, sysconfig) => void

Defined in: packages/types/src/terafoundation.ts:65

Type Parameters

Type Parameter	Default type
S	Record<string, any>

Parameters

Parameter	Type
config	Record<string, any>
sysconfig	SysConfig<S>

Returns

void