Skip to content
/ logts Public

A mirror of https://gitlab.com/gfour/logts so we can publish on deno.land/x

License

Notifications You must be signed in to change notification settings

Team-G4/logts

log.ts

An implementation of MicroLogger in Typescript that can be ran in Node.js or Deno (Coming Soon)

For anyone looking at this project on GitHub, it is an unmonitored mirror. The real project is hosted on GitLab

Demo

asciicast

Authors

Contributing

Contributions are always welcome!

See our contribution guide for ways to get started. Also, please make sure that you are adhering to this project's code of conduct.

License

log.ts, along with MicroLogger, is licensed under the BSD 3-Clause License. If you are not a legal expert, TL;DRLegal has a great explaination of the license.

Installation

We provide installations for both Node.js and Deno (Coming Soon)

Node.js

All major package managers (NPM, Yarn 1 and 2, and PNPM) are supported by us

NPM

  1. Add project repository to .npmrc
@gfour:registry=https://gitlab.com/api/v4/packages/npm/
  1. Install library
npm i @gfour/logts

Yarn 1.x (Classic)

  1. Add project repository to .yarnrc
"@guided-explorations:registry" "https://gitlab.com/api/v4/packages/npm/"
  1. Install library
yarn add @gfour/logts

Yarn 2.x (Berry)

  1. Add project repository to .yarnrc.yml
npmScopes:
  gfour:
    npmRegistryServer: "https://gitlab.com/api/v4/packages/npm/"
  1. Install library
yarn add @gfour/logts

PNPM

  1. Add project repository to .npmrc
@gfour:registry=https://gitlab.com/api/v4/packages/npm/
  1. Install library
pnpm i @gfour/logts

Deno

Coming soon! Check back later

Build Locally

Clone the project and enter the folder

git clone https://gitlab.com/gfour/logts.git
cd logts

Install dependencies

yarn install

Build the library

yarn run build

Usage/Examples

import { log, loggerLevel } from '@gfour/logts'

log(loggerLevel.OK, "This is a log entry with the severity level 'OK'")
log(loggerLevel.INFO, "This is a log entry with the severity level 'INFO'")
log(loggerLevel.EXTENSION, "This is a log entry with the severity level 'EXTENSION'")
log(loggerLevel.DEBUG, "This is a log entry with the severity level 'DEBUG'")
log(loggerLevel.WARN, "This is a log entry with the severity level 'WARN'")
log(loggerLevel.FAILED, "This is a log entry with the severity level 'FAILED'")
log(loggerLevel.FATAL, "This is a log entry with the severity level 'FATAL'")

Documentation

You can find more detailed information on our documentation.

Support

For support, email our service desk or submit an issue on our issue tracker. Both will funnel into the issue tracker.

Changelog

For every version, we publish detailed changelogs. You can view them here.