@vcsuite/publisher-sdk
TypeScript icon, indicating that this package has built-in type declarations

5.2.3 • Public • Published

@vcsuite/publisher-sdk

This package is an auto generated API to access the vcPUBLISHERs REST API. It uses the publisher OpenAPI document to generate a web & node SDK. For usage with node, you must have node-fetch installed as a dependency.

Installation

For use in a web app: npm i @vcsuite/publisher-sdk. For use in a node app: npm i node-fetch @vcsuite/publisher-sdk;

Usage

import * as api from '@vcsuite/publisher-sdk';

api.setServerUrl('http://localhost:3000');

const { _id: userId, token } = await api.postLogin({
  username: 'admin',
  password: 'admin123',
});
api.authorize(token);

const newProject = await api.postProject(
  { managerId: userId },
  { name: 'foo', bbox: [0, 0, 1, 1] },
);

For more examples, see the integration tests.

Readme

Keywords

none

Package Sidebar

Install

npm i @vcsuite/publisher-sdk

Weekly Downloads

29

Version

5.2.3

License

MIT

Unpacked Size

414 kB

Total Files

9

Last publish

Collaborators

  • bkuster
  • jbolling