occam-entities v1.0.92

Occam Entities

Occam's entities.

Contents

• Introduction
• Installation
• Usage
• Building
• Contact

Introduction

Occam's entities, namely things like files, projects, versions and so on.

Installation

With npm:

npm install occam-entities

You can also clone the repository with Git...

git clone https://github.com/djalbat/occam-entities.git

...and then install the dependencies with npm from within the project's root directory:

npm install

Usage

The exported classes are:

• File
• Files
• Version
• Entries
• Project
• Release
• Projects
• Releases
• Dependency
• Dependencies
• ShortenedVersion

There are also some utilities:

• contentUtilities
• filePathUtilities
• metaJSONUtilities

The classes have factory methods, see the source for details. Typical usage is:

const { File }} = require('occam-entities');

const json = ... ,
      file = file.fromJSON(json);

...

See the source for further information on the utilities.

In short, this package has little of use and only a little more of interest.

Building

Automation is done with npm scripts, have a look at the package.json file. The pertinent commands are:

npm run build-debug
npm run watch-debug

Contact

• james.smith@djalbat.com