@btilford/ts-base

Index

Enumerations

Join

Classes

Type aliases

Functions

Object literals

Type aliases

ApmBootstrap

ApmBootstrap: { features: Partial<Record<ApmFeatures, any>> }

Type declaration

features: Partial<Record<ApmFeatures, any>>

ApmFactory

ApmFactory<T>: T extends TimerWrapperFactory | CounterFactory<any> | GaugeFactory<any> | HistogramFactory<unknown> ? { name: string } : never

Type parameters

ApmFactoryInstance

ApmFactoryInstance<T, I>: T extends ApmFactory<any> ? I extends T ? I : never : any

Type parameters

ApmFeatures

ApmFeatures: keyof ApmEnv

Bool

Bool: True | False

BootstrapOptions

BootstrapOptions: { apm?: ApmBootstrap; appName: string; envLoaders?: Supplier<Record<string, string>>[]; log?: LogBoostrap; profiler?: Profiler; register?: [[any, string | { name: string }]] }

Type declaration

Optional apm?: ApmBootstrap
appName: string
Optional envLoaders?: Supplier<Record<string, string>>[]
Optional log?: LogBoostrap
Optional profiler?: Profiler
Optional register?: [[any, string | { name: string }]]

ConsoleApi

ConsoleApi: { assert?: undefined | ((value: any, message?: undefined | string, ...optionalParams: any[]) => void); clear?: undefined | (() => void); context?: unknown; count: (label?: undefined | string) => void; countReset: (label?: undefined | string) => void; debug: (message?: any, ...optionalParams: any[]) => void; dir?: undefined | ((obj: any, optional?: any) => void); dirxml?: undefined | ((...data: any[]) => void); error: (message?: any, ...optionalParams: any[]) => void; group: (...label: any[]) => void; groupCollapsed: (...label: any[]) => void; groupEnd: () => void; info: (message?: any, ...optionalParams: any[]) => void; log: (message?: any, ...optionalParams: any[]) => void; memory?: undefined | { jsHeapSizeLimit: number; totalJSHeapSize: number; usedJSHeapSize: number }; profile: (label?: undefined | string) => void; profileEnd: (label?: undefined | string) => void; table: (tabularData: any, properties?: string[]) => void; time: (label?: undefined | string) => void; timeEnd: (label?: undefined | string) => void; timeLog: (label?: undefined | string) => void; timeStamp: (label?: undefined | string) => void; trace: (message?: any, ...optionalParams: any[]) => void; warn: (message?: any, ...optionalParams: any[]) => void } | Console

ConsoleLogOptions

ConsoleLogOptions: LogOptions & { console?: ConsoleApi | Console; parent?: ConsoleLog }

ConsoleMetricFeature

ConsoleMetricFeature: { name: ApmFeatures extends string ? "counter" | "timer" : never; options: ConsoleMetricOptions }

Type declaration

name: ApmFeatures extends string ? "counter" | "timer" : never
options: ConsoleMetricOptions

ConsoleMetricOptions

ConsoleMetricOptions: { console?: Console; env?: Props; parent?: ConsoleMetric; prefix?: undefined | string; suffix?: undefined | string; tags?: Tags }

Type declaration

Optional console?: Console
Optional env?: Props
Optional parent?: ConsoleMetric
Optional prefix?: undefined | string
Optional suffix?: undefined | string
Optional tags?: Tags

Constructor

Constructor<T>: {}

Type parameters

Type declaration

CountOptions

CountOptions<T>: { counterFactory?: CounterFactory<T>; filter?: Filter; name?: undefined | string; tags?: Tags }

Type parameters

T: Numeric

Type declaration

Optional counterFactory?: CounterFactory<T>
Optional filter?: Filter
Optional name?: undefined | string
Optional tags?: Tags

Counter

Counter<T>: Metric & { increment: (val: T, tags?: Tags) => void }

Type parameters

T: Numeric

DatadogInterceptorOptions

DatadogInterceptorOptions: { datadog?: StatsD; eventOptions: EventOptions; extractText: (context: Message) => string | undefined; extractTitle: (context: Message) => string; filter: FilterLogMessage; onErr?: undefined | ((err: Error) => void); tags?: undefined | ((context: Message) => Tags) }

Type declaration

Optional datadog?: StatsD
eventOptions: EventOptions
extractText: (context: Message) => string | undefined
- - (context: Message): string | undefined
  - Parameters
    - context: Message
    Returns string | undefined
extractTitle: (context: Message) => string
- - (context: Message): string
  - Parameters
    - context: Message
    Returns string
filter: FilterLogMessage
Optional onErr?: undefined | ((err: Error) => void)
Optional tags?: undefined | ((context: Message) => Tags)

DayOfMonth

DayOfMonth: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31

DayOfWeek

DayOfWeek: 1 | 2 | 3 | 4 | 5 | 6 | 7

False

False: 0 | "false" | "False" | "FALSE" | "no" | "No" | "NO" | "n"

Gauge

Gauge<T>: Settable<T> & Counter<T>

Type parameters

T: Numeric

GaugeOptions

GaugeOptions<T>: { filter?: Filter; gaugeFactory?: GaugeFactory<T>; name?: undefined | string; tags?: Tags }

Type parameters

T: Numeric

Type declaration

Optional filter?: Filter
Optional gaugeFactory?: GaugeFactory<T>
Optional name?: undefined | string
Optional tags?: Tags

GaugeWrapperContext

GaugeWrapperContext<T>: { args: unknown[]; error?: unknown; result?: T }

Type parameters

Type declaration

args: unknown[]
Optional error?: unknown
Optional result?: T

GcpProject

GcpProject: "GCP_PROJECT" | "GCLOUD_PROJECT" | "GOOGLE_CLOUD_PROJECT"

Histogram

Histogram<T>: Settable<T>

Type parameters

Hour

Hour: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 18 | 19 | 20 | 21 | 22 | 23 | 24

HrTime

HrTime: [number, number]

HystrixCommandOptions

HystrixCommandOptions: CommandOptions & { circuitBreakerErrorThresholdPercentage?: undefined | number; circuitBreakerForceClosed?: unknown; circuitBreakerForceOpened?: unknown; circuitBreakerRequestVolumeThreshold?: undefined | number; circuitBreakerSleepWindowInMilliseconds?: undefined | number; cleanup?: unknown; context?: unknown; errorHandler?: undefined | ((err: unknown, ...args: unknown[]) => unknown); fallbackTo?: undefined | ((err: unknown, ...args: unknown[]) => unknown); percentileWindowLength?: undefined | number; percentileWindowNumberOfBuckets?: undefined | number; requestVolumeRejectionThreshold?: unknown; statisticalWindowLength?: undefined | number; statisticalWindowNumberOfBuckets?: undefined | number; timeout?: undefined | number }

IdleId

IdleId: number | RequestIdleCallbackHandle

InternalLogOptions

InternalLogOptions: { console?: Console; enable: { debug: boolean; table: boolean; warn: boolean }; parent?: string | { fqn: string } }

Type declaration

Optional console?: Console
enable: { debug: boolean; table: boolean; warn: boolean }
- debug: boolean
- table: boolean
- warn: boolean
Optional parent?: string | { fqn: string }

JoinOptions

JoinOptions: { execute: (err?: unknown, result?: unknown) => void; filter?: Filter; join: Join; original: (...args: unknown[]) => unknown; target: unknown }

Type declaration

execute: (err?: unknown, result?: unknown) => void
- - (err?: unknown, result?: unknown): void
  - Parameters
    - Optional err: unknown
    - Optional result: unknown
    Returns void
Optional filter?: Filter
join: Join
original: (...args: unknown[]) => unknown
- - (...args: unknown[]): unknown
  - Parameters
    - Rest ...args: unknown[]
    Returns unknown
target: unknown

Key

Key: string | KeyFallback

KeyFallback

KeyFallback: { global?: undefined | string; name: string }

Type declaration

Optional global?: undefined | string
name: string

LocalTimerOptions

LocalTimerOptions: { env?: Props; parent?: LocalTimerWrapper<any, any>; prefix?: undefined | string; suffix?: undefined | string; tags?: Tags; timerFactory?: TimerFactory }

Type declaration

Optional env?: Props
Optional parent?: LocalTimerWrapper<any, any>
Optional prefix?: undefined | string
Optional suffix?: undefined | string
Optional tags?: Tags
Optional timerFactory?: TimerFactory

LogBoostrap

LogBoostrap: { root: Log }

Type declaration

root: Log

LogConfigOptions

LogConfigOptions: { contextSupplier?: Context; interceptors?: Interceptor[]; messageFormat?: MessageFormat; messageTemplate?: MessageTemplate; rootLevel?: LogLevel }

Type declaration

Optional contextSupplier?: Context
Optional interceptors?: Interceptor[]
Optional messageFormat?: MessageFormat
Optional messageTemplate?: MessageTemplate
Optional rootLevel?: LogLevel

LogFeature

LogFeature: keyof LogEnv

LogInvocationOptions

LogInvocationOptions: { filter?: Filter; includeResult?: undefined | false | true; level: LogLevel; name?: undefined | string; parent?: Log }

Type declaration

Optional filter?: Filter
Optional includeResult?: undefined | false | true
level: LogLevel
Optional name?: undefined | string
Optional parent?: Log

LogMessage

LogMessage: string | MessageContext

LogOptions

LogOptions: { config?: LogConfigOptions; env?: Env; name?: undefined | string; parent?: Log }

Type declaration

[key: string]: unknown | undefined
Optional config?: LogConfigOptions
Optional env?: Env
Optional name?: undefined | string
Optional parent?: Log

Metric

Metric: { name: string; tags: Tags }

Type declaration

name: string
tags: Tags

Milliseconds

Milliseconds: number | bigint

Month

Month: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

Named

Named<T>: string | { name: string } | Constructor<T>

Type parameters

NanoTime

NanoTime: Nanoseconds | TimeMeasurement

Nanoseconds

Nanoseconds: bigint

NotPromise

NotPromise<T>: Exclude<T, Promise<T>>

Type parameters

Numeric

Numeric: number | bigint

PerformanceTimerOptions

PerformanceTimerOptions: { endSuffix?: undefined | string; env?: Props; measureSuffix?: undefined | string; parent?: PerformanceTimer<any>; performance?: Performance; startSuffix?: undefined | string; tags?: Tags }

Type declaration

Optional endSuffix?: undefined | string
Optional env?: Props
Optional measureSuffix?: undefined | string
Optional parent?: PerformanceTimer<any>
Optional performance?: Performance
Optional startSuffix?: undefined | string
Optional tags?: Tags

ProfileOptions

ProfileOptions: { filter?: Filter; label?: undefined | string; profiler?: Profiler }

Type declaration

Optional filter?: Filter
Optional label?: undefined | string
Optional profiler?: Profiler

ProfilerOptions

ProfilerOptions: { env?: Env; parent?: Profiler }

Type declaration

Optional env?: Env
Optional parent?: Profiler

PromFeature

PromFeature: { name: ApmFeatures; options: PromOptions; prefix?: undefined | string }

Type declaration

name: ApmFeatures
options: PromOptions
Optional prefix?: undefined | string

PromOptions

PromOptions: { additionalTagNames?: string[]; aggregator?: Aggregator; help: string; prefix?: undefined | string; registry?: Registry; suffix?: undefined | string; tags?: Tags }

Type declaration

Optional additionalTagNames?: string[]

prom-client requires configuring the tags that will be used before calling collection methods. You can provide names for tags that can't be set until the method invocation here.
Optional aggregator?: Aggregator
help: string
Optional prefix?: undefined | string
Optional registry?: Registry
Optional suffix?: undefined | string
Optional tags?: Tags

RangeOptions

RangeOptions: { from?: undefined | number; to?: undefined | number }

Type declaration

Optional from?: undefined | number
Optional to?: undefined | number

RequestIdleCallbackDeadline

RequestIdleCallbackDeadline: { didTimeout: boolean; timeRemaining: () => number }

Type declaration

Readonly didTimeout: boolean
timeRemaining: () => number
- - (): number
  - Returns number

RequestIdleCallbackHandle

RequestIdleCallbackHandle: any

RequestIdleCallbackOptions

RequestIdleCallbackOptions: { timeout: number }

Type declaration

timeout: number

RetryOptions

RetryOptions: { backoff?: number | number[]; interval?: number | number[]; maxAttempts: number; name?: undefined | string }

Type declaration

Optional backoff?: number | number[]
Optional interval?: number | number[]
maxAttempts: number
Optional name?: undefined | string

Settable

Settable<T>: Metric & { set: any }

Type parameters

StackdriverInterceptorOptions

StackdriverInterceptorOptions: { callback?: undefined | ((err: Error, response: ServerResponse | null, body: {}) => void); errorBuilder: ErrorBuilder; errors?: ErrorReporting; filter: (context: Message) => boolean }

Type declaration

Optional callback?: undefined | ((err: Error, response: ServerResponse | null, body: {}) => void)

This is included for testing...

param

param

param
errorBuilder: ErrorBuilder
Optional errors?: ErrorReporting
filter: (context: Message) => boolean
- - (context: Message): boolean
  - Parameters
    - context: Message
    Returns boolean

StackdriverJsonFormat

StackdriverJsonFormat: { @type: string; context: { httpRequest: { method: string; referrer: string; remoteIp: string; responseStatusCode: number; url: string; userAgent: string }; reportLocation: { filePath: string; functionName: string; lineNumber: number }; user: string }; eventTime: string; message: string; serviceContext: { service: string; version: string } }

Type declaration

@type: string
context: { httpRequest: { method: string; referrer: string; remoteIp: string; responseStatusCode: number; url: string; userAgent: string }; reportLocation: { filePath: string; functionName: string; lineNumber: number }; user: string }
- httpRequest: { method: string; referrer: string; remoteIp: string; responseStatusCode: number; url: string; userAgent: string }
  - method: string
  - referrer: string
  - remoteIp: string
  - responseStatusCode: number
  - url: string
  - userAgent: string
- reportLocation: { filePath: string; functionName: string; lineNumber: number }
  - filePath: string
  - functionName: string
  - lineNumber: number
- user: string
eventTime: string
message: string
serviceContext: { service: string; version: string }
- service: string
- version: string

StatsDFeature

StatsDFeature: { name: ApmFeatures; options?: StatsDOptions }

Type declaration

name: ApmFeatures
Optional options?: StatsDOptions

StatsDOptions

StatsDOptions: { prefix?: undefined | string; sampleRate?: undefined | number; statsd?: StatsD; suffix?: undefined | string; tags?: Tags }

Type declaration

Optional prefix?: undefined | string
Optional sampleRate?: undefined | number
Optional statsd?: StatsD
Optional suffix?: undefined | string
Optional tags?: Tags

StdLogOptions

StdLogOptions: StdOutOptions & LogOptions & { parent?: StdOutLog }

StdOutOptions

StdOutOptions: { stderr?: Writable; stdout?: Writable }

Type declaration

Optional stderr?: Writable

Will default to process.stderr
Optional stdout?: Writable

Will default to process.stdout

TimeAndRemainder

TimeAndRemainder: [bigint, bigint]

TimedOptions

TimedOptions: { filter?: Filter; name?: undefined | string; tags?: Tags; timerWrapper?: TimerWrapperFactory }

Type declaration

Optional filter?: Filter
Optional name?: undefined | string
Optional tags?: Tags
Optional timerWrapper?: TimerWrapperFactory

Timer

Timer: Metric & { elapsed: () => Duration | undefined; end: (tags?: Tags) => Duration | undefined; mark: (name: string, tags?: Tags) => Duration | undefined; start: (tags?: Tags) => TimeMeasurement | undefined }

True

True: 1 | "true" | "True" | "TRUE" | "yes" | "Yes" | "YES" | "y"

Value

Value<T>: Metric & { value: T }

Type parameters

Win

Win: Window & { cancelIdleCallback: (handle: RequestIdleCallbackHandle) => void; requestIdleCallback: (callback: (deadline: RequestIdleCallbackDeadline) => void, opts?: RequestIdleCallbackOptions) => RequestIdleCallbackHandle }

Variables

Const ACCESS_TEMPLATE

ACCESS_TEMPLATE: "${ctx.data.req.ip} - - [${ctx.data.ts}] ${ctx.data.pid} "${ctx.data.req.method} ${ctx.data.req.url} " ${ctx.data.res.status} ${ctx.data.res.length} - "${ctx.data.req.userAgent}" ${ctx.message}" = "${ctx.data.req.ip} - - [${ctx.data.ts}] ${ctx.data.pid} "${ctx.data.req.method} ${ctx.data.req.url} " ${ctx.data.res.status} ${ctx.data.res.length} - "${ctx.data.req.userAgent}" ${ctx.message}"

Const APM_ENV

APM_ENV: ApmEnv = new ApmEnv()

Const BASE_ROOT

BASE_ROOT: "ts-base" = "ts-base"

Const ENV_PROFILER

ENV_PROFILER: "profiler" = "profiler"

Const LOG_ENV

LOG_ENV: LogEnv = new LogEnv()

Const MS_IN_SEC

MS_IN_SEC: bigint = BigInt(1000)

Const NANOS_IN_CENTURY

NANOS_IN_CENTURY: bigint = NANOS_IN_DECADE * BigInt(100)

Const NANOS_IN_DAY

NANOS_IN_DAY: bigint = NANOS_IN_HOUR * BigInt(24)

Const NANOS_IN_DECADE

NANOS_IN_DECADE: bigint = NANOS_IN_YEAR * BigInt(10)

Const NANOS_IN_HOUR

NANOS_IN_HOUR: bigint = NANOS_IN_MIN * BigInt(60)

Const NANOS_IN_MIN

NANOS_IN_MIN: bigint = NANOS_IN_SEC * BigInt(60)

Const NANOS_IN_MONTH

NANOS_IN_MONTH: bigint = NANOS_IN_DAY * BigInt(30)

Const NANOS_IN_MS

NANOS_IN_MS: bigint = BigInt(1000000)

Const NANOS_IN_SEC

NANOS_IN_SEC: bigint = NANOS_IN_MS * MS_IN_SEC

Const NANOS_IN_WEEK

NANOS_IN_WEEK: bigint = NANOS_IN_DAY * BigInt(7)

Const NANOS_IN_YEAR

NANOS_IN_YEAR: bigint = NANOS_IN_MONTH * BigInt(12)

Const TRUE

TRUE: "true" = "true"

Let app

app: Providers

Let instance

instance: Env

Let internalLog

internalLog: InternalLog

Const nodeTimeFactory

nodeTimeFactory: NodeTimeFactory = new NodeTimeFactory()

Const system

system: { hasWindow: boolean; isNode: boolean } = _system

Type declaration

hasWindow: boolean
isNode: boolean

Let timeFactory

timeFactory: TimeFactory

Let timerFactory

timerFactory: TimerFactory

Functions

CircuitBreaker

CircuitBreaker(options: CommandOptions, commandFactory?: CommandFactory): (Anonymous function)

- Defined in packages/core/src/errors/circuit/command.ts:22
Parameters
- options: CommandOptions
- Optional commandFactory: CommandFactory
Returns (Anonymous function)

CountErrors

CountErrors(options?: CountOptions<number>): MethodDecorator

- Defined in packages/core/src/apm/counter.ts:122
Parameters
- Default value options: CountOptions<number> = {}
Returns MethodDecorator

CountInvocations

CountInvocations(options?: CountOptions<number>): MethodDecorator

- Defined in packages/core/src/apm/counter.ts:34
Parameters
- Default value options: CountOptions<number> = {}
Returns MethodDecorator

CountSuccess

CountSuccess(options?: CountOptions<number>): MethodDecorator

- Defined in packages/core/src/apm/counter.ts:75
Parameters
- Default value options: CountOptions<number> = {}
Returns MethodDecorator

Const DEFAULT_NODE_CONTEXT_SUPPLIER

DEFAULT_NODE_CONTEXT_SUPPLIER(): { pid: number; timestamp: string }

- Defined in packages/node/src/log/node-context.ts:3
Returns { pid: number; timestamp: string }
- pid: number
- timestamp: string

GaugeErrors

GaugeErrors(options?: GaugeOptions<number>): MethodDecorator

- Defined in packages/core/src/apm/gauge.ts:124
Parameters
- Default value options: GaugeOptions<number> = {}
Returns MethodDecorator

GaugeInvocations

GaugeInvocations(options?: GaugeOptions<number>): MethodDecorator

- Defined in packages/core/src/apm/gauge.ts:39
Parameters
- Default value options: GaugeOptions<number> = {}
Returns MethodDecorator

GaugeSuccess

GaugeSuccess(options?: GaugeOptions<number>): MethodDecorator

- Defined in packages/core/src/apm/gauge.ts:80
Parameters
- Default value options: GaugeOptions<number> = {}
Returns MethodDecorator

LogInvocation

LogInvocation(options: LogInvocationOptions): MethodDecorator

- Defined in packages/core/src/log/decorators.ts:31
Wrap and log a function invocation.
```
@LogInvocation() function f(a:string) {}
f('A');
// > f(A)
```
Parameters
- options: LogInvocationOptions
Returns MethodDecorator

Profile

Profile(options?: ProfileOptions): MethodDecorator

- Defined in packages/core/src/profiling/decorators.ts:17
Parameters
- Default value options: ProfileOptions = {}
Returns MethodDecorator

ProfileTimestamp

ProfileTimestamp(options?: ProfileOptions): MethodDecorator

- Defined in packages/core/src/profiling/decorators.ts:51
Parameters
- Default value options: ProfileOptions = {}
Returns MethodDecorator

Retry

Retry(options: RetryOptions): MethodDecorator

- Defined in packages/core/src/errors/retry.ts:192
Parameters
- options: RetryOptions
Returns MethodDecorator

Const SUPPLY_UNDEFINED

SUPPLY_UNDEFINED(): undefined

- Defined in packages/core/src/util/supplier.ts:6
Returns undefined

Timed

Timed<T, P>(options?: TimedOptions): MethodDecorator

- Defined in packages/core/src/apm/timed.ts:31
Type parameters
- T
- P: NotPromise<T>
Parameters
- Default value options: TimedOptions = {}
Returns MethodDecorator

TimedAsync

TimedAsync<T, P>(options?: TimedOptions): MethodDecorator

- Defined in packages/core/src/apm/timed.ts:76
Type parameters
- T
- P: Promise<T>
Parameters
- Default value options: TimedOptions = {}
Returns MethodDecorator

accept

accept(filter?: Filter | { filter?: Filter }): boolean

- Defined in packages/core/src/decorators/filters.ts:44
Parameters
- Optional filter: Filter | { filter?: Filter }
Returns boolean

acceptFilter

acceptFilter<T>(options: { filter?: Filter | { filter?: Filter }; no: () => T; yes: () => T }): T

- Defined in packages/core/src/decorators/filters.ts:61
Type parameters
- T
Parameters
- options: { filter?: Filter | { filter?: Filter }; no: () => T; yes: () => T }
  - Optional filter?: Filter | { filter?: Filter }
  - no: () => T
    - - (): T
      - Returns T
  - yes: () => T
    - - (): T
      - Returns T
Returns T

bootstrap

bootstrap(options: BootstrapOptions): void

- Defined in packages/core/src/bootstrap.ts:25
Parameters
- options: BootstrapOptions
Returns void

cancelIdleCallback

cancelIdleCallback(id: IdleId): void

- Defined in packages/core/src/util/asyncrify.ts:51
Parameters
- id: IdleId
Returns void

cleanMetricName

cleanMetricName(name: string): string

- Defined in packages/node/src/apm/prometheus/metric.ts:20
Parameters
- name: string
Returns string

createPrometheusFeature

createPrometheusFeature(feature: PromFeature): ApmFactoryInstance<any, any>

- Defined in packages/node/src/apm/prometheus/prometheus.ts:31
Parameters
- feature: PromFeature
Returns ApmFactoryInstance<any, any>

createStatsDFeature

createStatsDFeature(feature: StatsDFeature): ApmFactoryInstance<any, any>

- Defined in packages/node/src/apm/statsd/statsd.ts:31
Parameters
- feature: StatsDFeature
Returns ApmFactoryInstance<any, any>

datadogInterceptor

datadogInterceptor(options?: DatadogInterceptorOptions): Interceptor

- Defined in packages/node/src/integrations/datadog-interceptor.ts:29
Parameters
- Default value options: DatadogInterceptorOptions = defaultDatadogInterceptorOptions
Returns Interceptor

debug

debug(name: string): (message: string | MessageContext, ...args: unknown[]) => void

- Defined in packages/core/src/internal/log.ts:87
Parameters
- name: string
Returns (message: string | MessageContext, ...args: unknown[]) => void
- - (message: string | MessageContext, ...args: unknown[]): void
  - Parameters
    - message: string | MessageContext
    - Rest ...args: unknown[]
    Returns void

debugEnv

debugEnv(): Record<string, string>

- Defined in packages/core/src/internal/debug-env.ts:9
Returns Record<string, string>

Const defaultStackdriverErrorBuilder

defaultStackdriverErrorBuilder(event: ErrorMessage, context: Message): ErrorMessage

- Defined in packages/node/src/integrations/gcp/stackdriver-error-reporting.ts:20
Parameters
- event: ErrorMessage
- context: Message
Returns ErrorMessage

documentQueryLoader

documentQueryLoader(selector: string, extractor: ElementExtractor, document: { querySelectorAll: any } | Document): Supplier<Record<string, string>>

- Defined in packages/browser/src/browser-env.ts:8
Parameters
- selector: string
- extractor: ElementExtractor
- document: { querySelectorAll: any } | Document
Returns Supplier<Record<string, string>>

first

first<T>(val: T | undefined, ...args: T[]): T | undefined

- Defined in packages/core/src/collections/util.ts:1
Type parameters
- T
Parameters
- val: T | undefined
- Rest ...args: T[]
Returns T | undefined

getTimeFactory

getTimeFactory(): TimeFactory

- Defined in packages/core/src/time/time-factory.ts:23
Returns TimeFactory

getTimerFactory

getTimerFactory(): TimerFactory

- Defined in packages/core/src/apm/local/timer.ts:120
Returns TimerFactory

idleCallback

idleCallback(callable: () => void, options: RequestIdleCallbackOptions): IdleId

- Defined in packages/core/src/util/asyncrify.ts:34
Parameters
- callable: () => void
  - - (): void
    - Returns void
- options: RequestIdleCallbackOptions
Returns IdleId

interceptFilter

interceptFilter(filter: FilterLogMessage, intercept: Interceptor): Interceptor

- Defined in packages/core/src/log/interceptor.ts:19
Parameters
- filter: FilterLogMessage
- intercept: Interceptor
Returns Interceptor

joinError

joinError(options: JoinOptions, ...args: unknown[]): any

- Defined in packages/core/src/decorators/join.ts:17
Parameters
- options: JoinOptions
- Rest ...args: unknown[]
Returns any

joinFqn

joinFqn(appendName: PropertyKey | { name: string }, parent?: string | { fqn: string }, separator?: string): string

- Defined in packages/core/src/util/strings.ts:6
Parameters
- appendName: PropertyKey | { name: string }
- Optional parent: string | { fqn: string }
- Default value separator: string = "."
Returns string

loadEnvWithMetaTags

loadEnvWithMetaTags(namePrefix: string, document: Document): Supplier<Record<string, string>>

- Defined in packages/browser/src/browser-env.ts:39
Parameters
- namePrefix: string
- document: Document
Returns Supplier<Record<string, string>>

loadEnvWithObj

loadEnvWithObj(object: Record<string, string>): Supplier<Record<string, string>>

- Defined in packages/core/src/env.ts:86
Parameters
- object: Record<string, string>
Returns Supplier<Record<string, string>>

logLevelFilter

logLevelFilter(level: LogLevel): FilterLogMessage

- Defined in packages/core/src/log/interceptor.ts:13
Parameters
- level: LogLevel
Returns FilterLogMessage

logProvider

logProvider(orRegister?: Supplier<Log>): Log

- Defined in packages/core/src/log/log-provider.ts:6
Parameters
- Default value orRegister: Supplier<Log> = (): Log => ConsoleLog.create()
Returns Log

logger

logger(name: string | { name: string } | Constructor<any>, _console?: Console): InternalLog

- Defined in packages/core/src/internal/log.ts:54
Parameters
- name: string | { name: string } | Constructor<any>
- Optional _console: Console
Returns InternalLog

metaContentExtractor

metaContentExtractor(prefix?: string): ElementExtractor

- Defined in packages/browser/src/browser-env.ts:23
Parameters
- Default value prefix: string = ""
Returns ElementExtractor

millisAsNanoString

millisAsNanoString(milllis: Milliseconds, postfix?: "" | "n"): string

- Defined in packages/core/src/time/util.ts:21
Parameters
- milllis: Milliseconds
- Default value postfix: "" | "n" = ""
Returns string

millisAsNanos

millisAsNanos(millis: Milliseconds): bigint

- Defined in packages/core/src/time/util.ts:32
Parameters
- millis: Milliseconds
Returns bigint

nameOrFqn

nameOrFqn(name?: undefined | string, target?: any, property?: PropertyKey): string

- Defined in packages/core/src/util/strings.ts:1
Parameters
- Optional name: undefined | string
- Optional target: any
- Optional property: PropertyKey
Returns string

nanosAsJsDate

nanosAsJsDate(nanos: NanoTime): Date

- Defined in packages/core/src/time/util.ts:68
Parameters
- nanos: NanoTime
Returns Date

nanosAsMillis

nanosAsMillis(nanos: NanoTime, truncate?: boolean): Milliseconds

- Defined in packages/core/src/time/util.ts:62
Parameters
- nanos: NanoTime
- Default value truncate: boolean = false
Returns Milliseconds

nanosAsString

nanosAsString(nanos: NanoTime, postfix?: "" | "n"): string

- Defined in packages/core/src/time/util.ts:26
Parameters
- nanos: NanoTime
- Default value postfix: "" | "n" = ""
Returns string

nextTick

nextTick(callable: (...args: unknown[]) => void, ...args: unknown[]): void

- Defined in packages/core/src/util/asyncrify.ts:4
Parameters
- callable: (...args: unknown[]) => void
  - - (...args: unknown[]): void
    - Parameters
      - Rest ...args: unknown[]
      Returns void
- Rest ...args: unknown[]
Returns void

or

or<T>(val: T | undefined, fallback: T): T

- Defined in packages/core/src/util/condition.ts:2
Type parameters
- T
Parameters
- val: T | undefined
- fallback: T
Returns T

orUseSupplier

orUseSupplier<T>(item: T | undefined, supplier: Supplier<T>): T

- Defined in packages/core/src/util/supplier.ts:8
Type parameters
- T
Parameters
- item: T | undefined
- supplier: Supplier<T>
Returns T

processEnvLoader

processEnvLoader(filter?: (key: string, value: string) => boolean): Record<string, string>

- Defined in packages/node/src/node-env-loader.ts:1
Parameters
- Default value filter: (key: string, value: string) => boolean = () => true
  - - (key: string, value: string): boolean
    - Parameters
      - key: string
      - value: string
      Returns boolean
Returns Record<string, string>

rawNanos

rawNanos(nanos: NanoTime): bigint

- Defined in packages/core/src/time/util.ts:6
Parameters
- nanos: NanoTime
Returns bigint

registerDatadog

registerDatadog(statsd: StatsD): void

- Defined in packages/node/src/integrations/datadog-provider.ts:4
Parameters
- statsd: StatsD
Returns void

registerErrorReporting

registerErrorReporting(errors?: ErrorReporting): ErrorReporting

- Defined in packages/node/src/integrations/gcp/stackdriver-error-reporting.ts:7
Parameters
- Optional errors: ErrorReporting
Returns ErrorReporting

registerPrometheusFeature

registerPrometheusFeature(feature: PromFeature): void

- Defined in packages/node/src/apm/prometheus/prometheus.ts:51
Parameters
- feature: PromFeature
Returns void

registerRootRegistry

registerRootRegistry(registry: Registry): void

- Defined in packages/node/src/apm/prometheus/prometheus.ts:26
Parameters
- registry: Registry
Returns void

registerStatsD

registerStatsD(statsd: StatsD): void

- Defined in packages/node/src/apm/statsd/statsd.ts:26
Parameters
- statsd: StatsD
Returns void

registerStatsDFeature

registerStatsDFeature(feature: StatsDFeature): void

- Defined in packages/node/src/apm/statsd/statsd.ts:51
Parameters
- feature: StatsDFeature
Returns void

retry

retry(fn: () => Promise<unknown>, options: RetryOptions): Promise<unknown>

- Defined in packages/core/src/errors/retry.ts:122
Parameters
- fn: () => Promise<unknown>
  - - (): Promise<unknown>
    - Returns Promise<unknown>
- options: RetryOptions
Returns Promise<unknown>

setTimeFactory

setTimeFactory(factory?: TimeFactory): TimeFactory

- Defined in packages/core/src/time/time-factory.ts:13
Parameters
- Optional factory: TimeFactory
Returns TimeFactory

setTimerFactory

setTimerFactory(factory: TimerFactory): TimerFactory

- Defined in packages/core/src/apm/local/timer.ts:114
Parameters
- factory: TimerFactory
Returns TimerFactory

shift

shift(val?: number | number[]): number | undefined

- Defined in packages/core/src/errors/retry.ts:28
Parameters
- Optional val: number | number[]
Returns number | undefined

stackdriverInterceptor

stackdriverInterceptor(options?: StackdriverInterceptorOptions): Interceptor

- Defined in packages/node/src/integrations/gcp/stackdriver-error-reporting.ts:49
Parameters
- Default value options: StackdriverInterceptorOptions = DefaultStackdriverInterceptorOptions
Returns Interceptor

tagString

tagString(tags: Tags, entrySeparator?: string, itemSeparator?: string): string

- Defined in packages/core/src/util/tags.ts:3
Parameters
- tags: Tags
- Default value entrySeparator: string = ":"
- Default value itemSeparator: string = ","
Returns string

templateString

templateString(template?: undefined | string): MessageTemplate

- Defined in packages/core/src/log/message-template.ts:68
Parameters
- Optional template: undefined | string
Returns MessageTemplate

timePart

timePart(nanos: NanoTime, unit: Nanoseconds): TimeAndRemainder

- Defined in packages/core/src/time/util.ts:37
Parameters
- nanos: NanoTime
- unit: Nanoseconds
Returns TimeAndRemainder

timePartValue

timePartValue(nanos: NanoTime, unit: Nanoseconds): bigint

- Defined in packages/core/src/time/util.ts:44
Parameters
- nanos: NanoTime
- unit: Nanoseconds
Returns bigint

timeParts

timeParts(nanos: NanoTime, parts: { name: string; unit: bigint }[]): Record<string, bigint>

- Defined in packages/core/src/time/util.ts:49
Parameters
- nanos: NanoTime
- parts: { name: string; unit: bigint }[]
Returns Record<string, bigint>

wrapJoin

wrapJoin(options: JoinOptions, ...args: unknown[]): any

- Defined in packages/core/src/decorators/join.ts:29
Parameters
- options: JoinOptions
- Rest ...args: unknown[]
Returns any

Object literals

Const CONSOLE_APM

CONSOLE_APM: object

features

features: object

counter

counter: ConsoleCounterFactory = new ConsoleCounterFactory({})

timer

timer: ConsoleTimerFactory = new ConsoleTimerFactory({})

Const DefaultStackdriverInterceptorOptions

DefaultStackdriverInterceptorOptions: object

filter

filter: FilterLogMessage = logLevelFilter(LogLevel.ALERT)

errorBuilder

errorBuilder(event: ErrorMessage, context: Message): ErrorMessage

- Defined in packages/node/src/integrations/gcp/stackdriver-error-reporting.ts:40
Parameters
- event: ErrorMessage
- context: Message
Returns ErrorMessage

Const GCP_ENV_VARS

GCP_ENV_VARS: object

ENTRY_POINT

ENTRY_POINT: string = "ENTRY_POINT"

FUNCTION_IDENTITY

FUNCTION_IDENTITY: string = "FUNCTION_IDENTITY"

FUNCTION_MEMORY_MB

FUNCTION_MEMORY_MB: string = "FUNCTION_MEMORY_MB"

FUNCTION_NAME

FUNCTION_NAME: string = "FUNCTION_NAME"

FUNCTION_REGION

FUNCTION_REGION: string = "FUNCTION_REGION"

FUNCTION_SIGNATURE_TYPE

FUNCTION_SIGNATURE_TYPE: string = "FUNCTION_SIGNATURE_TYPE"

FUNCTION_TARGET

FUNCTION_TARGET: string = "FUNCTION_TARGET"

FUNCTION_TIMEOUT_SEC

FUNCTION_TIMEOUT_SEC: string = "FUNCTION_TIMEOUT_SEC"

FUNCTION_TRIGGER_TYPE

FUNCTION_TRIGGER_TYPE: string = "FUNCTION_TRIGGER_TYPE"

GCLOUD_PROJECT

GCLOUD_PROJECT: string = "GCLOUD_PROJECT"

GCP_PROJECT

GCP_PROJECT: string = "GCP_PROJECT"

GOOGLE_APPLICATION_CREDENTIALS

GOOGLE_APPLICATION_CREDENTIALS: string = "GOOGLE_APPLICATION_CREDENTIALS"

GOOGLE_CLOUD_PROJECT

GOOGLE_CLOUD_PROJECT: string = "GOOGLE_CLOUD_PROJECT"

K_REVISION

K_REVISION: string = "K_REVISION"

K_SERVICE

K_SERVICE: string = "K_SERVICE"

PORT

PORT: string = "PORT"

Const MSG_FMT

MSG_FMT: object

annotatingClass

annotatingClass: string = "Annotating Class %s with @%s(%o)"

annotatingMethod

annotatingMethod: string = "Annotating Method %s.%s with @%s(%o)"

Const WHEN

WHEN: object

interval

interval(milliseconds: number): Filter

- Defined in packages/core/src/decorators/filters.ts:7
Parameters
- milliseconds: number
Returns Filter

once

once(): Filter

- Defined in packages/core/src/decorators/filters.ts:33
Returns Filter

sampled

sampled(lessThan: number, random?: Function): Filter

- Defined in packages/core/src/decorators/filters.ts:34
Parameters
- lessThan: number
- Optional random: Function
Returns Filter

times

times(count: number): Filter

- Defined in packages/core/src/decorators/filters.ts:23
Parameters
- count: number
Returns Filter

Const _system

_system: object

hasWindow

hasWindow: boolean = typeof window !== 'undefined'

isNode

isNode: boolean = typeof process !== 'undefined' && process?.release?.name === 'node'

Const defaultDatadogInterceptorOptions

defaultDatadogInterceptorOptions: object

extractText

extractText(context: Message): any

- Defined in packages/node/src/integrations/datadog-interceptor.ts:25
Parameters
- context: Message
Returns any

extractTitle

extractTitle(context: Message): string

- Defined in packages/node/src/integrations/datadog-interceptor.ts:24
Parameters
- context: Message
Returns string

filter

filter(context: Message): boolean

- Defined in packages/node/src/integrations/datadog-interceptor.ts:18
Parameters
- context: Message
Returns boolean

eventOptions

eventOptions: object

alert_type

alert_type: "error" = "error"

priority

priority: "normal" = "normal"

Const defaultOptions

defaultOptions: object

enable

enable: object

debug

debug: false = false

table

table: false = false

warn

warn: false = false

Const rawMessageTemplate

rawMessageTemplate: object

Adds no additonal context to the message string.

format

format(context: MessageContext): string

- Defined in packages/core/src/log/message-template.ts:24
Parameters
- context: MessageContext
Returns string

context.message

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ApmBootstrap

Type declaration

features: Partial<Record<ApmFeatures, any>>

ApmFactory

Type parameters

T

ApmFactoryInstance

Type parameters

T

I

ApmFeatures

Bool

BootstrapOptions

Type declaration

Optional apm?: ApmBootstrap

appName: string

Optional envLoaders?: Supplier<Record<string, string>>[]

Optional log?: LogBoostrap

Optional profiler?: Profiler

Optional register?: [[any, string | { name: string }]]

ConsoleApi

ConsoleLogOptions

ConsoleMetricFeature

Type declaration

name: ApmFeatures extends string ? "counter" | "timer" : never

options: ConsoleMetricOptions

ConsoleMetricOptions

Type declaration

Optional console?: Console

Optional env?: Props

Optional parent?: ConsoleMetric

Optional prefix?: undefined | string

Optional suffix?: undefined | string

Optional tags?: Tags

Constructor

Type parameters

T

Type declaration

CountOptions

Type parameters

T: Numeric

Type declaration

Optional counterFactory?: CounterFactory<T>

Optional filter?: Filter

Optional name?: undefined | string

Optional tags?: Tags

Counter

Type parameters

T: Numeric

DatadogInterceptorOptions

Type declaration

Optional datadog?: StatsD

eventOptions: EventOptions

extractText: (context: Message) => string | undefined

Parameters

context: Message

Returns string | undefined

extractTitle: (context: Message) => string

Parameters

context: Message

Returns string

filter: FilterLogMessage

Optional onErr?: undefined | ((err: Error) => void)

Optional tags?: undefined | ((context: Message) => Tags)

DayOfMonth

DayOfWeek

False

Gauge

Type parameters

T: Numeric

GaugeOptions