spy-log

• Installation
• Synopsis
• Details
• API
  • Table of contents
    • Enumerations
    • Classes
    • Interfaces
  • References
    • default
  • Type aliases
    • RecordType
• Classes
• Class: Log
  • Hierarchy
  • Constructors
    • constructor
  • Properties
    • curStage
    • namespace
    • console
    • getLogFn
  • Methods
    • debug
    • error
    • group
    • info
    • log
    • print
    • printGroup
    • stage
    • warn
• Class: LogGroup
  • Hierarchy
  • Constructors
    • constructor
  • Properties
    • curStage
    • namespace
    • console
    • getLogFn
  • Methods
    • debug
    • end
    • error
    • group
    • info
    • log
    • print
    • printGroup
    • stage
    • warn
• Enums
• Enumeration: LogLevel
  • Enumeration members
    • Error
    • Info
    • Log
    • Verbose
    • Warning
• Interfaces
• Interface: GroupRecord
  • Properties
    • collapsed
    • name
    • records
• Interface: LogRecord
  • Properties
    • level
    • message
    • stage
    • time

Installation

npm install spy-log

Format	Instructions
TypeScript	import Log from "spy-log";
Node (CommonJS)	const { Log } = require("spy-log");
ES Modules (Browsers, webpack)	import Log from "spy-log";

Synopsis

import Log from 'spy-log';

async function subTask(logger) {
  logger.info('massage in suntask');
  await request('http://example.com', logger.group('getExample'));
  logger.end();
}

const logger = new Log('main');

logger.log('main start');
subTask(logger.group('subtask'));

Details

API

Table of contents

Enumerations

• LogLevel

Classes

• Log
• LogGroup

Interfaces

• GroupRecord
• LogRecord

References

default

Renames and exports: Log

Type aliases

RecordType

Ƭ RecordType: LogRecord | GroupRecord

Log-records stored in LogGroup.records

Defined in: index.ts:48

Classes

spy-log / Log

Class: Log

Hierarchy

• Log

  ↳ LogGroup

Constructors

constructor

+ new Log(namespace: string): Log

Parameters:

Name	Type
namespace	string

Returns: Log

Defined in: index.ts:69

Properties

curStage

• Protected Optional curStage: string

Defined in: index.ts:72

---

namespace

• Protected namespace: string

---

console

▪ Static console: Console

Defined in: index.ts:68

---

getLogFn

▪ Static getLogFn: (level: LogLevel) => (...data: any[]) => void

Type declaration:

▸ (level: LogLevel): function

Parameters:

Name	Type
level	LogLevel

Returns: (...data: any[]) => void

Defined in: index.ts:62

Defined in: index.ts:69

Methods

debug

▸ debug(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Defined in: index.ts:79

---

error

▸ error(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Defined in: index.ts:95

---

group

▸ group(name: string): LogGroup

Parameters:

Name	Type
name	string

Returns: LogGroup

Defined in: index.ts:121

---

info

▸ info(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Defined in: index.ts:87

---

log

▸ log(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Defined in: index.ts:83

---

print

▸ print(message: any[], level: LogLevel, stage?: undefined | string, inGroup?: boolean): void

Parameters:

Name	Type
message	any[]
level	LogLevel
stage	undefined | string
inGroup?	boolean

Returns: void

Defined in: index.ts:99

---

printGroup

▸ printGroup(name: string, records: RecordType[], collapsed: boolean): void

Parameters:

Name	Type
name	string
records	RecordType[]
collapsed	boolean

Returns: void

Defined in: index.ts:106

---

stage

▸ stage(str: string): Log

Parameters:

Name	Type
str	string

Returns: Log

Defined in: index.ts:74

---

warn

▸ warn(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Defined in: index.ts:91

spy-log / LogGroup

Class: LogGroup

Hierarchy

• Log

  ↳ LogGroup

Constructors

constructor

+ new LogGroup(name: string, parent: Log | LogGroup, collapsed?: boolean): LogGroup

Parameters:

Name	Type	Default value
name	string	-
parent	Log | LogGroup	-
collapsed	boolean	false

Returns: LogGroup

Inherited from: Log

Defined in: index.ts:128

Properties

curStage

• Protected Optional curStage: string

Inherited from: Log.curStage

Defined in: index.ts:72

---

namespace

• Protected namespace: string

Inherited from: Log.namespace

---

console

▪ Static console: Console

Inherited from: Log.console

Defined in: index.ts:68

---

getLogFn

▪ Static getLogFn: (level: LogLevel) => (...data: any[]) => void

Type declaration:

▸ (level: LogLevel): function

Parameters:

Name	Type
level	LogLevel

Returns: (...data: any[]) => void

Defined in: index.ts:62

Inherited from: Log.getLogFn

Defined in: index.ts:69

Methods

debug

▸ debug(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Inherited from: Log

Defined in: index.ts:79

---

end

▸ end(): void

Returns: void

Defined in: index.ts:150

---

error

▸ error(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Inherited from: Log

Defined in: index.ts:95

---

group

▸ group(name: string): LogGroup

Parameters:

Name	Type
name	string

Returns: LogGroup

Inherited from: Log

Defined in: index.ts:121

---

info

▸ info(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Inherited from: Log

Defined in: index.ts:87

---

log

▸ log(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Inherited from: Log

Defined in: index.ts:83

---

print

▸ print(message: any[], level: LogLevel, stage?: undefined | string): void

Parameters:

Name	Type
message	any[]
level	LogLevel
stage	undefined | string

Returns: void

Overrides: Log

Defined in: index.ts:133

---

printGroup

▸ printGroup(name: string, records: RecordType[], collapsed: boolean): void

Parameters:

Name	Type
name	string
records	RecordType[]
collapsed	boolean

Returns: void

Overrides: Log

Defined in: index.ts:142

---

stage

▸ stage(str: string): LogGroup

Parameters:

Name	Type
str	string

Returns: LogGroup

Inherited from: Log

Defined in: index.ts:74

---

warn

▸ warn(...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: void

Inherited from: Log

Defined in: index.ts:91

Enums

spy-log / LogLevel

Enumeration: LogLevel

LogLevel.Log is identical to LogLevel.Info

see https://developers.google.com/web/tools/chrome-devtools/console/reference#level

Enumeration members

Error

• Error: = 4

Defined in: index.ts:11

---

Info

• Info: = 2

Defined in: index.ts:9

---

Log

• Log: = 1

Defined in: index.ts:8

---

Verbose

• Verbose: = 0

Defined in: index.ts:7

---

Warning

• Warning: = 3

Defined in: index.ts:10

Interfaces

spy-log / GroupRecord

Interface: GroupRecord

Properties

collapsed

• collapsed: boolean

except the group is initially collapsed when it's logged to the Console

Defined in: index.ts:38

---

name

• name: string

name of a log-group

Example

> [namespace]name
····[stage]message in a group

Defined in: index.ts:34

---

records

• records: RecordType[]

records in a log-group

Defined in: index.ts:42

spy-log / LogRecord

Interface: LogRecord

Properties

level

• level: LogLevel

Defined in: index.ts:23

---

message

• message: any[]

messages to print

Defined in: index.ts:22

---

stage

• Optional stage: string

stage of a log-record

Example

[namespace][stage]message

Defined in: index.ts:20

---

time

• time: Date

Defined in: index.ts:24