@thadeu/logger-storage

0.1.12 • Public • Published

logger-storage

NPM package version Build Status Minified size Minified+Gzip size License: MIT

Console.log out of the box.

Instalation

This lib is available as a NPM package. To install it, use the following command:

npm install @thadeu/logger-storage --save

If you're using Yarn (and you should):

yarn add @thadeu/logger-storage

If you dont use ES6/7/8/x, use unpkg file

https://unpkg.com/@thadeu/logger-storage@0.1.12/dist/logger-storage.min.js

API

  • sync -> start process
  • logger -> save to localStorage
  • all -> get all logs
  • filter -> filter logs
  • logs -> filter only logs
  • errors -> filter only errors
  • warns -> filter only warns
  • infos -> filter only infos
  • clear -> clear storage

.sync({ ...options })

auto_start

Type: Boolean

Default: true

reloadClear

Type: Boolean

Default: true

only

Type: Array

Default: ['error', 'info', 'log', 'warn']

Usage

import * as LoggerStorage from "@thadeu/logger-storage";
LoggerStorage.sync({
  only: ["error"]
});

Get all logs

LoggerStorage.all().then(items => {
  console.log(items);
});

Get only logs

LoggerStorage.logs().then(items => {
  console.log(items);
});

Get only errors

LoggerStorage.errors().then(items => {
  console.log(items);
});

Get only warns

LoggerStorage.warns().then(items => {
  console.log(items);
});

Get only infos

loggerStorage.infos().then(items => {
  console.log(items);
});

Logger manually

LoggerStorage.sync({
  auto_start: false
});

LoggerStorage.logger("testing with logger storage", {
  type_event: "log", // 'error', 'info', 'log', 'warn'
  timestamp: new Date()
  // others custom attributes
});

Clear all logs

LoggerStorage.clear();

Do you developer?

starting project

npm run start

watching tests

npm run test:watch

We going to enjoy!!

Contributing

Once you've made your great commits (include tests, please):

  1. Fork this repository
  2. Create a topic branch - git checkout -b my_branch
  3. Push to your branch - git push origin my_branch
  4. Create a pull request

That's it!

Please respect the indentation rules and code style. And use 2 spaces, not tabs. And don't touch the version thing or distribution files; this will be made when a new version is going to be released.

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i @thadeu/logger-storage

Weekly Downloads

2

Version

0.1.12

License

MIT

Unpacked Size

358 kB

Total Files

9

Last publish

Collaborators

  • thadeu