TracingChannel.prototype.traceSync

method TracingChannel.prototype.traceSync

Unstable

Usage

import { TracingChannel } from "node:diagnostics_channel";


        TracingChannel.prototype.traceSync<ThisArg = any, Args extends any[] = any[]>(fn: (this: ThisArg, ...args: Args) => any
context?: ContextType
thisArg?: ThisArg
...args: Args
): void

Trace a synchronous function call. This will always produce a start event and end event around the execution and may produce an error event if the given function throws an error. This will run the given function using channel.runStores(context, ...) on the start channel which ensures all events should have any bound stores set to match this trace context.

import diagnostics_channel from 'node:diagnostics_channel';

const channels = diagnostics_channel.tracingChannel('my-channel');

channels.traceSync(() => {
  // Do something
}, {
  some: 'thing',
});

Type Parameters

ThisArg = any

Args extends any[] = any[]

Parameters

fn: (this: ThisArg, ...args: Args) => any

Function to wrap a trace around

optional

context: ContextType

Shared object to correlate events through

optional

thisArg: ThisArg

The receiver to be used for the function call

...args: Args

Return Type

void

The return value of the given function