Skip to content

archoleat/notifier

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Notifier

NPM Version NPM Downloads Specs Commitlint Editorconfig Prettier ESLint Remark

Table of Contents

A small, simple and customizable notifier for your projects.

Installation

bun i -D @archoleat/notifier

Usage

import { error, info, success, warning } from '@archoleat/notifier';

await info({
  message: 'string' | ['string', { maxLength: number }],
  // Enable/disable timestamp, not work in desktop mode, @default true.
  hasTime: boolean,
  // Available modes: console, desktop, multiple, @default 'console'.
  notificationMode: 'console' | 'desktop' | 'multiple',
});

Contributing

Please read CONTRIBUTING to start contributing.

License

This project is licensed under the MIT license.

Contributors 4

  •  
  •  
  •  
  •