@terascope/types / terafoundation / FoundationAPIs

Interface: FoundationAPIs

Properties

promMetrics

promMetrics: PromMetrics

Source

terafoundation.ts:98

Methods

createClient()

createClient(config): Promise<ConnectorOutput>

Parameters

Parameter	Type
config	ConnectionConfig

Returns

Promise<ConnectorOutput>

Source

terafoundation.ts:96

---

getSystemEvents()

getSystemEvents(): EventEmitter<DefaultEventMap>

Returns

EventEmitter<DefaultEventMap>

Source

terafoundation.ts:95

---

makeLogger()

makeLogger(metadata)

makeLogger(metadata?): Logger

Create a child logger

Parameters

Parameter	Type
metadata?	Record<string, string>

Returns

Logger

Source

terafoundation.ts:92

makeLogger(name, filename)

makeLogger(name, filename): Logger

Create the root logger (usually done automatically)

Parameters

Parameter	Type
name	string
filename	string

Returns

Logger

Source

terafoundation.ts:94

---

startWorkers()

startWorkers(num, envOptions): FoundationWorker[]

Parameters

Parameter	Type
num	number
envOptions	Record<string, any>

Returns

FoundationWorker[]

Source

terafoundation.ts:97