Class CreamSoda

Hierarchy

LeveledGroup
- CreamSoda

Indexable

[key: string]: any

Index

Constructors

constructor

Properties

Methods

Object literals

Constructors

constructor

new CreamSoda(): CreamSoda

Overrides LeveledGroup.constructor
- Defined in cream-soda.ts:38
Returns CreamSoda

Properties

LogData

LogData: LogData = LogData

utils

utils: "utils" = utils

Methods

Protected _setter

_setter(name: string, setter: function): void

Inherited from LogGroup._setter
- Defined in group.ts:202
_setter - creates a setter for a setting

Parameters
- name: string
  
  the name of the setting.
- setter: function
  
  the function used to set the value. should accept a value and return another.
  - - (value: any): any
    - Parameters
      - value: any
      Returns any
Returns void

add

add(transport: Transport | Function, global?: boolean): LogGroup

Overrides LogGroup.add
- Defined in cream-soda.ts:76
add - like add allows for each subgroup

override

Parameters
- transport: Transport | Function
- Default value global: boolean = false
Returns LogGroup

format

format(name: string, fmt: string, global?: boolean): LogGroup

Overrides LogGroup.format
- Defined in cream-soda.ts:124
format - like format allows for each subgroup

override

Parameters
- name: string
- fmt: string
- Default value global: boolean = false
Returns LogGroup

get

get(name: string): any

Inherited from LogGroup.get
- Defined in group.ts:118
get - returns the value of a setting.

Parameters
- name: string
  
  the name of the setting.
Returns any

the value of the setting.

level

level(name: string, value: number, color?: string): void

Inherited from LeveledGroup.level
- Defined in groups/leveled.ts:77
level - adds a new level

Parameters
- name: string
  
  the name of the level
- value: number
  
  the numberical value to rank the level
- Default value color: string = "none"
  
  the name of the color to use
Returns void

remove

remove(transport: Transport | Function | string, global?: boolean): LogGroup

Overrides LogGroup.remove
- Defined in cream-soda.ts:92
remove - like remove allows for each subgroup

override

Parameters
- transport: Transport | Function | string
- Default value global: boolean = false
Returns LogGroup

set

set(name: string, value: any, global?: boolean): LogGroup

Overrides LogGroup.set
- Defined in cream-soda.ts:108
set - like set allows for each subgroup

override

Parameters
- name: string
- value: any
- Default value global: boolean = false
Returns LogGroup

subgroup

subgroup(name: string, group: LogGroup | Function): LogGroup

- Defined in cream-soda.ts:60
subgroup - adds new subgroup to logger

Parameters
- name: string
  
  the name of the property to add it to
- group: LogGroup | Function
  
  the group to add
Returns LogGroup

token

token(name: string, tkn: Token, global?: boolean): LogGroup

Overrides LogGroup.token
- Defined in cream-soda.ts:140
token - like token allows for each subgroup

override

Parameters
- name: string
- tkn: Token
- Default value global: boolean = false
Returns LogGroup

write

write(chunk: string | Object, callback?: function): void

Inherited from LogGroup.write
- Defined in group.ts:161
write - writes out to every transport

Parameters
- chunk: string | Object
  
  the chunk to write out
- Default value callback: function = () => {}
  
  this is called when the write is done. If there was an error it is passed to this.
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

void

Object literals

groups

groups: object

AccessGroup

AccessGroup: AccessGroup

LeveledGroup

LeveledGroup: LeveledGroup

LogGroup

LogGroup: LogGroup

transports

transports: object

Console

Console: Console

Transport

Transport: Transport

Generated using TypeDoc