Giter VIP home page Giter VIP logo

cos-api4node's Introduction

Known Vulnerabilities

cos-api4node

InterSystems Atelier REST API wrapper for NodeJS. Supports v1 Atelier API.

Installation

Install this package as a dependency using npm:

npm install cos-api4node

Usage

const api4node = require('cos-api4node');

const api = api4node({
    host: '127.0.0.1',
    port: 57772, 
    path: '/api/atelier/',
    version: 'v1', 
    ns: 'USER', 
    username: '_SYSTEM',
    password: 'SYS',
    https: false,
    compileflags: 'cuk'
});

// Get info about server
api.getServer((error, server) => {
    console.log(server);
});

Supported API

  • compile(docs, [callback])
    • Compile all docs listed in the given array docs (for example, ["My.Class.cls", "Program.mac", ...]). docs also can be a single string meaning one document to compile.
  • deleteDocs(docs, [callback])
    • Delete all docs listed in the given array docs (for example, ["My.Class.cls", "Program.mac", ...]). docs also can be a single string meaning one document to delete.
  • getServer(callback)
    • Returns information about the server, including Caché Source Code File REST API version and namespaces that are available on the server.
  • getDoc(doc, callback)
    • Returns the data of the given doc. For example, doc can be a 'Routine.mac' or 'Class.Name.cls'.
  • getDocNames(options, callback)
    • Returns a list of source code file names. Following options can be specified:
      • options.generated Specifies that generated source code files should be included.
  • headServer(callback)
    • Returns the HttpHeader for the server.
  • putDoc(name, doc, [options], [callback])
    • Creates or updates document name with data doc. Returns the updated document. See official docs for more info. The following optional options can be specified:
      • options['If-None-Match'] Specifies the version (ts) of the document to overwrite if the document already exists. If the given timestamp (ts) does not match server's one, the 409 Conflict will occur. You can bypass this check with ignoreConflict option.
      • options['ignoreConflict'] Forces the source code file to be written to the server even if the file has changed since you previously accessed it.

Development

After making any changes, run the tests:

npm test

License

MIT

cos-api4node's People

Contributors

doublefint avatar nikitaeverywhere avatar daimor avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.