@terascope/types / terafoundation / FoundationAPIs

Interface: FoundationAPIs

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

Properties

Property	Type	Defined in
promMetrics	PromMetrics	packages/types/src/terafoundation.ts:98

Methods

createClient()

createClient(config): Promise<ConnectorOutput>

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

Parameters

Parameter	Type
config	ConnectionConfig

Returns

Promise<ConnectorOutput>

---

getSystemEvents()

getSystemEvents(): EventEmitter

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

Returns

EventEmitter

---

makeLogger()

Call Signature

makeLogger(metadata?): Logger

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

Create a child logger

Parameters

Parameter	Type
metadata?	Record<string, string>

Returns

Logger

Call Signature

makeLogger(name, filename): Logger

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

Create the root logger (usually done automatically)

Parameters

Parameter	Type
name	string
filename	string

Returns

Logger

---

startWorkers()

startWorkers(num, envOptions): FoundationWorker[]

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

Parameters

Parameter	Type
num	number
envOptions	Record<string, any>

Returns

FoundationWorker[]