npm.io
1.0.620 • Published yesterday

occam-model

Licence
MIT, Anti-996
Version
1.0.620
Deps
3
Size
249 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

Occam Model

Parts of Occam's model.

Contents

Introduction

Parts of Occam's model, such as files, projects, versions and so on.

Installation

With npm:

npm install occam-model

You can also clone the repository with Git...

git clone https://github.com/djalbat/occam-model.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-model');

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