https://github.com/lemoncloud-io/lemon-logger-lib
Common logger for browser
https://github.com/lemoncloud-io/lemon-logger-lib
Last synced: about 2 months ago
JSON representation
Common logger for browser
- Host: GitHub
- URL: https://github.com/lemoncloud-io/lemon-logger-lib
- Owner: lemoncloud-io
- Created: 2019-11-19T05:04:52.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2020-07-21T12:48:34.000Z (about 6 years ago)
- Last Synced: 2025-10-11T20:22:42.408Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 516 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# lemon-logger-lib
[](https://travis-ci.org/lemoncloud-io/lemon-logger-lib)
TypeScript console logger for LemonCloud
## Install
```
$ npm install @lemoncloud/lemon-logger-lib
```
## Usage
### default
```typescript
import { Logger } from '@lemoncloud/lemon-logger-lib';
const logger = new Logger('LEMON');
const logger2 = new Logger('LEMON2', { showTimestamp: false, showLogType: false });
logger.log('this is log', 'extra params: ', { type: 'debug'});
logger.debug('this is debug', 'extra params: ', { type: 'debug'});
logger2.info('this is info', 'extra params: ', { type: 'info'});
logger2.warn('this is warn', 'extra params: ', { type: 'warn'});
logger2.error('this is error', 'extra params: ', { type: 'error'}, 'test');
```
### http
```typescript
const logger = new Logger('LEMON', {
shouldSend: true,
httpHost: 'http://localhost:8333',
httpMethod: 'POST',
httpPath: '/mock/log',
});
```
### socket
```typescript
const logger = new Logger('LEMON', {
useSocket: true,
socketHost: 'http://localhost:5555',
socketEvent: 'LOG',
});
```
## Options
### Logger([namespace], [options])
##### showTimestamp
Type: `boolean`
Default: `true`
##### showLogType
Type: `boolean`
Default: `true`
##### shouldSend
Type: `boolean`
Default: `false`
##### httpHost
Type: `string`
Default: `''`
##### httpMethod
Type: `string`
Default: `''`
##### httpPath
Type: `string`
Default: `''`
##### useSocket
Type: `boolean`
Default: `false`
##### socketHost
Type: `string`
Default: `''`
##### socketEvent
Type: `string`
Default: `''`
## Methods
#### `logger.log('test message')`
#### `logger.debug('test message')`
#### `logger.info('test message')`
#### `logger.warn('test message')`
#### `logger.error('test message')`
#### `logger.setOptions({ shouldSend: false })`
#### `logger.closeSocket()`
## Sample
A quick sample is provided as [example.js](./example/example.js)