@rbxts/rlog > withLogContext

withLogContext() function

Wraps around a callback, automatically creating and managing the lifecycle for a LogContext.

Signature:

export declare function withLogContext<R = void>(callback: ContextCallback<R>): R;

Parameters

Parameter	Type	Description
callback	ContextCallback<R>	ContextCallback scope to run and provide the context for.

Returns:

R

Remarks

The callback will be invoked immediately, and within the same thread.

Any errors thrown within the callback will be re-thrown after calling stop on the created context to avoid memory leaks.

Any value returned from the callback will also be propagated appropriately.

Example

remotes.buyPet.connect((player: Player, pet: PetId) => {
  // automatically starts and stops the context
  withLogContext((context) => {
    buyPet(context, player.UserId, pet);
  });
});