https://github.com/fabiospampinato/tiny-updater

The smallest update notifier for NPM packages, useful for CLI apps.
https://github.com/fabiospampinato/tiny-updater

notifier notify npm tiny update updater

Last synced: about 2 months ago
JSON representation

The smallest update notifier for NPM packages, useful for CLI apps.

• Host: GitHub
• URL: https://github.com/fabiospampinato/tiny-updater
• Owner: fabiospampinato
• License: mit
• Created: 2021-05-12T12:29:42.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-10T15:40:34.000Z (10 months ago)
• Last Synced: 2024-11-08T09:35:49.200Z (3 months ago)
• Topics: notifier, notify, npm, tiny, update, updater
• Language: TypeScript
• Size: 32.2 KB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# Tiny Updater

A small update notifier for NPM packages, useful for CLI apps.

## Pros & Cons

This is basically a bare-bones alternative to [update-notifier](https://github.com/yeoman/update-notifier), with all the pros and cons of that.

- **Small**: This library has only a handful of small and reliable dependencies. This library weighs about ~5kb total.

- **Bundler-ready**: This library can be bundled, which is important for achieving the best startup times. `update-notifier` on the other hand uses highly dyanmic imports and spawns a child process, if you are using it you can't bundle your CLI app.

- **Fast**: Startup performance is paramount for CLI apps, in order to improve that you need to bundle your app and make the bundle as small as possible, using this library won't compromise your startup times much.

- **Bare-bones**: Being lightweight comes at a cost, that cost is mainly less visually-sophisticated update messages written to the console compared to `update-notifier`, but still I think the output is pretty good.

- **Work in progress**: While this library should suit most use cases it's currently less flexible than `update-notifier`, if you need something fancy this may not work for you.

## Install

```sh

npm install --save tiny-updater

```

## Usage

```ts

import updater from 'tiny-updater';

import {name, version} from './package.json';

await updater ({ name, version, ttl: 86_400_000 });

// If there are no updates available:

// 1. `false` is returned

// 2. Nothing is logged to the console

// If there is an update available:

// 1. `true` is returned

// 2. At most once a day, right before the process exits, a message like the following is logged to the console:

// 📦 Update available for example-package: 0.1.0 → 1.0.0

```

## License

MIT © Fabio Spampinato