@terascope/types / terafoundation

terafoundation

Interfaces

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

Type Aliases

Cluster

Cluster = Overwrite<NodeJSCluster, { workers: {[id: string]: FoundationWorker; }; 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

Properties

cluster_name?

optional cluster_name: string | (sysconfig) => string

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

config_schema?

optional config_schema: any

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

default_config_file?

optional default_config_file: string

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

descriptors?

optional descriptors: Record<D, string>

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

master()?

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

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

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

schema_formats?

optional schema_formats: Format[]

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

script()?

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

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

Parameters

Parameter	Type
context	Context<S, A, D>

Returns

void | Promise<void>

shutdownMessaging?

optional shutdownMessaging: boolean

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

start_workers?

optional start_workers: boolean

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

worker()?

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

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

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

Properties

apis

apis: ContextAPIs & A

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

arch

arch: string

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

assignment

assignment: D

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

cluster

cluster: Cluster

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

cluster_name?

optional cluster_name: string

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

logger

logger: Logger

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

name

name: string

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

platform

platform: string

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

sysconfig

sysconfig: SysConfig<S>

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

---

ContextAPIs

ContextAPIs = object

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

Indexable

[namespace: string]: any

Properties

foundation

readonly foundation: FoundationAPIs

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

Methods

registerAPI()

registerAPI(namespace, apis): void

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

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>

Properties

schema

schema: Schema<S>

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

validatorFn?

optional validatorFn: ValidatorFn<S>

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

---

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

Properties

config

config: Record<string, any>

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

connector?

optional connector: boolean

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

validatorFn?

optional validatorFn: ValidatorFn<S>

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

---

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