Docfox SDK

A NodeJS SDK based on the DocFox API Documentation

License	Test Coverage	Documentation

Versioning

In order to allow for fast releases and bug fixes, every commit and version are published to the package registry. Production-ready releases are versioned using the standard semvar versioning, while development builds are versioned using the following scheme: 0.0.0-%%branch%%-%%commit hash%%. This allows for easy identification of the commit that was used to build the package, and allows for easy upgrades to newer versions, while preventing unstable versions from clashing with stable versions.

Installation

npm

First, add the registry for the package to your project's .npmrc file. You can do this by running the following command:

echo @docfox:registry=https://gitlab.jak.guru/api/v4/projects/387/packages/npm/ >> .npmrc

or just add @docfox:registry=https://gitlab.jak.guru/api/v4/projects/387/packages/npm/ to your .npmrc file.

Then, install the package:

npm i @docfox/[email protected]

yarn

First, add the registry for the package to your project's .yarnrc file. You can do this by running the following command:

echo "\"@docfox:registry\" \"https://gitlab.jak.guru/api/v4/projects/387/packages/npm/\"" >> .yarnrc

or just add "@docfox:registry" "https://gitlab.jak.guru/api/v4/projects/387/packages/npm/" to your .yarnrc file.

Then, install the package:

yarn add @docfox/[email protected]

Usage

Typescript / ES6

import DocFoxSDK from '@docfox/docfox-software-development-kit'
const client = new DocFoxSDK('<docfox api key>', '<docfox api secret>')

CommonJS

const DocFoxSDK = require('@docfox/docfox-software-development-kit')
const client = new DocFoxSDK('<docfox api key>', '<docfox api secret>')