@royalarchives/catalog-favorites v1.0.6

Library: Favorites

A module for Library that allows you to maintain a list of your favorite objects.

Documentation

• How to use
• Index data structure
• Using the API with NodeJS

How to use

First install the module with NPM:

$ npm install @royalarchives/library-favorites

If you are using Library from the command-line include the module name in your arguments:

$ node scanner.js @royalarchives/library-favorites /path/to/files

If you are using Library with NodeJS include the module name in the parameters:

const Library = require('@royalarchives/library')
await Library.scan(['@royalarchives/library-favorites'], ['/path/to/files'])

Index data structure

Top of page

Using the API with NodeJS

Top of page

License

MIT