Class ContextManager

ContextManager handles context data for logging.

Features:

Deep merging of context objects
Circular reference detection
Value sanitization
Context validation
Snapshot management
Performance optimization

ContextManager

Example

const contextManager = new ContextManager({
  maxDepth: 5,
  sanitizeMode: 'strict'
});

// Set global context
contextManager.set({
  app: 'my-app',
  version: '1.0.0'
});

// Merge additional context
const merged = contextManager.merge(globalContext, localContext);

Hierarchy

EventEmitter
- ContextManager

Index

Constructors

constructor

Methods

clear clearSnapshots destroy extract flatten get getSnapshots getStats merge restore set setSchema setValidationRules snapshot unflatten validate

Constructors

constructor

new ContextManager(options?: ContextManagerOptions): ContextManager
Creates a new ContextManager instance.
Parameters
- options: ContextManagerOptions = {}
  Configuration options
Returns ContextManager
Overrides EventEmitter.constructor
- Defined in core/ContextManager.ts:226

Methods

clear

clear(): void
Clear global context.

Returns void
- Defined in core/ContextManager.ts:268

clearSnapshots

clearSnapshots(): void
Clear all snapshots.

Returns void
- Defined in core/ContextManager.ts:776

destroy

destroy(): void
Clean up resources.

Returns void
- Defined in core/ContextManager.ts:972

extract

extract(
context: Record<string, unknown>,
fields: string[],
): Record<string, unknown>
Extract specific fields from context.
Parameters
- context: Record<string, unknown>
  Source context
- fields: string[]
  Fields to extract
Returns Record<string, unknown>
Extracted context
- Defined in core/ContextManager.ts:854

flatten

flatten(
context: Record<string, unknown>,
prefix?: string,
): Record<string, unknown>
Flatten nested context to dot notation.
Parameters
- context: Record<string, unknown>
  Context to flatten
- Optionalprefix: string = ''
  Key prefix
Returns Record<string, unknown>
Flattened context
- Defined in core/ContextManager.ts:788

get

get(): Record<string, unknown>
Get global context.

Returns Record<string, unknown>
Global context
- Defined in core/ContextManager.ts:259

getSnapshots

getSnapshots(): ContextSnapshot[]
Get all snapshots.

Returns ContextSnapshot[]
All snapshots
- Defined in core/ContextManager.ts:769

getStats

getStats(): {
    depth: number;
    propertyCount: number;
    size: number;
    snapshotCount: number;
}
Get context statistics.

Returns { depth: number; propertyCount: number; size: number; snapshotCount: number }
Context statistics
- Defined in core/ContextManager.ts:927

merge

merge(
...contexts: (undefined | Record<string, unknown>)[],
): Record<string, unknown>
Merge multiple context objects.
Parameters
- ...contexts: (undefined | Record<string, unknown>)[]
  Contexts to merge
Returns Record<string, unknown>
Merged context
- Defined in core/ContextManager.ts:279

restore

restore(snapshot: ContextSnapshot): void
Restore from a snapshot.
Parameters
- snapshot: ContextSnapshot
  Snapshot to restore
Returns void
- Defined in core/ContextManager.ts:756

set

set(context: Record<string, unknown>): void
Set global context.
Parameters
- context: Record<string, unknown>
  Context to set
Returns void
- Defined in core/ContextManager.ts:249

setSchema

setSchema(schema: AnySchema, mode?: "warn" | "silent" | "throw"): void

Sets a schema for context validation.

Parameters

schema: AnySchema
The schema to use for validation
Optionalmode: "warn" | "silent" | "throw"
Validation mode

Returns void

Example

import { object, string, number } from 'magiclogger/validation';

contextManager.setSchema(
  object({
    userId: string({ format: 'uuid' }),
    sessionId: string(),
    requestCount: number({ min: 0 })
  }),
  'throw' // Strict mode - throw on validation errors
);

setValidationRules

setValidationRules(rules: ContextValidationRules): void
Set validation rules.
Parameters
- rules: ContextValidationRules
  Validation rules
Returns void
- Defined in core/ContextManager.ts:622

snapshot

snapshot(metadata?: Record<string, unknown>): ContextSnapshot
Create a snapshot of current context.
Parameters
- Optionalmetadata: Record<string, unknown>
  Optional metadata
Returns ContextSnapshot
Created snapshot
- Defined in core/ContextManager.ts:732

unflatten

unflatten(flattened: Record<string, unknown>): Record<string, unknown>
Unflatten dot notation to nested object. Converts a flat object with dot-notation keys into a nested object structure.
Parameters
- flattened: Record<string, unknown>
  Flattened context
Returns Record<string, unknown>
Nested context
- Defined in core/ContextManager.ts:816

validate

validate(context: Record<string, unknown>): ContextValidationResult
Validate context against rules.
Parameters
- context: Record<string, unknown>
  Context to validate
Returns ContextValidationResult
Validation result
- Defined in core/ContextManager.ts:666

Class ContextManager

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ContextManager

Methods

clear

Returns void

clearSnapshots

Returns void

destroy

Returns void

extract

Parameters

Returns Record<string, unknown>

flatten

Parameters

Returns Record<string, unknown>

get

Returns Record<string, unknown>

getSnapshots

Returns ContextSnapshot[]

getStats

Returns { depth: number; propertyCount: number; size: number; snapshotCount: number }

merge

Parameters

Returns Record<string, unknown>

restore

Parameters

Returns void

set

Parameters

Returns void

setSchema

Parameters

Returns void

Example

setValidationRules

Parameters

Returns void

snapshot

Parameters

Returns ContextSnapshot

unflatten

Parameters

Returns Record<string, unknown>

validate

Parameters

Returns ContextValidationResult

Settings

On This Page