@terascope/types / terafoundation

terafoundation

Interfaces

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

Type Aliases

Cluster

Cluster: Overwrite<NodeJSCluster, { workers: {}; fork: FoundationWorker; }>

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

---

Config<S, A, D>

Config<S, A, D>: object

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

Type Parameters

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

Type declaration

cluster_name?

optional cluster_name: string | (sysconfig) => string

config_schema?

optional config_schema: any

default_config_file?

optional default_config_file: string

descriptors?

optional descriptors: Record<D, string>

master()?

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

Parameters

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

Returns

void | Promise<void>

name

name: string

schema_formats?

optional schema_formats: Format[]

script()?

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

Parameters

Parameter	Type
context	Context<S, A, D>

Returns

void | Promise<void>

shutdownMessaging?

optional shutdownMessaging: boolean

start_workers?

optional start_workers: boolean

worker()?

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

Parameters

Parameter	Type
context	Context<S, A, D>

Returns

void | Promise<void>

---

Context<S, A, D>

Context<S, A, D>: object

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

Type Parameters

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

Type declaration

apis

apis: ContextAPIs & A

arch

arch: string

assignment

assignment: D

cluster

cluster: Cluster

cluster_name?

optional cluster_name: string

logger

logger: Logger

name

name: string

platform

platform: string

sysconfig

sysconfig: SysConfig<S>

---

ContextAPIs

ContextAPIs: object

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

Type declaration

Index Signature

[namespace: string]: any

foundation

readonly foundation: FoundationAPIs

registerAPI()

Parameters

Parameter	Type
namespace	string
apis	any

Returns

void

---

CreateClientFactoryFn()

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

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

Parameters

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

Returns

Promise<ConnectorOutput>

---

Initializers<S>

Initializers<S>: object

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

Type Parameters

Type Parameter	Default type
S	Record<string, any>

Type declaration

schema

schema: Schema<S>

validatorFn?

optional validatorFn: ValidatorFn<S>

---

LogLevelConfig

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

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

---

LogLevelType

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

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

---

LogType

LogType: "console" | "file"

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

---

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:215

---

Schema<T>

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

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

Type Parameters

Type Parameter
T

---

SysConfig<S>

SysConfig<S>: object & S

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

Type declaration

_nodeName

_nodeName: string

terafoundation

terafoundation: TerafoundationConfig

Type Parameters

Type Parameter
S

---

ValidationObj<S>

ValidationObj<S>: object

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

Type Parameters

Type Parameter
S

Type declaration

config

config: Record<string, any>

connector?

optional connector: boolean

validatorFn?

optional validatorFn: ValidatorFn<S>

---

ValidatorFn()<S>

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

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

Type Parameters

Type Parameter	Default type
S	Record<string, any>

Parameters

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

Returns

void