npm package: @starinformatics/ncats-trapi-client
Description: NCATS Javascript Client for TRAPI-wrapped Knowledge Resources
Latest version: 0.0.4

# @starinformatics/ncats-trapi-client

client - JavaScript client for @starinformatics/ncats-trapi-client
OpenAPI for NCATS Biomedical Translator Reasoners
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 0.0.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @starinformatics/ncats-trapi-client --save
```

Finally, you need to build the module:

```shell
npm run build
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your @starinformatics/ncats-trapi-client from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
npm run build
```

#### git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var client = require('@starinformatics/ncats-trapi-client');


var api = new client.PredicatesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.predicates(callback);

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*client.PredicatesApi* | [**predicates**](docs/PredicatesApi.md#predicates) | **GET** /predicates | Get supported relationships by source and target
*client.QueryApi* | [**query**](docs/QueryApi.md#query) | **POST** /query | Query reasoner via one of several inputs


## Documentation for Models

 - [client.Attribute](docs/Attribute.md)
 - [client.Edge](docs/Edge.md)
 - [client.EdgeBinding](docs/EdgeBinding.md)
 - [client.KnowledgeGraph](docs/KnowledgeGraph.md)
 - [client.LogEntry](docs/LogEntry.md)
 - [client.Message](docs/Message.md)
 - [client.Node](docs/Node.md)
 - [client.NodeBinding](docs/NodeBinding.md)
 - [client.QEdge](docs/QEdge.md)
 - [client.QNode](docs/QNode.md)
 - [client.Query](docs/Query.md)
 - [client.QueryGraph](docs/QueryGraph.md)
 - [client.Response](docs/Response.md)
 - [client.Result](docs/Result.md)


## Documentation for Authorization

All endpoints do not require authorization.