@teemill/file-processor
TypeScript icon, indicating that this package has built-in type declarations

0.3.4 • Public • Published

@teemill/file-processor@0.3.4

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

  • Node.js
  • Webpack
  • Browserify

Language level

  • ES5 - you must have a Promises/A+ library installed
  • ES6

Module system

  • CommonJS
  • ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @teemill/file-processor@0.3.4 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.localhost:8080

Class Method HTTP request Description
HealthApi getHealth GET /healthz Get health
ProcessorApi createJob POST /jobs Create job
ProcessorApi deleteJob DELETE /jobs/{job} Delete job
ProcessorApi getJob GET /jobs/{job} Get job
ProcessorApi listJobs GET /jobs List jobs

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api-key

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

session-oauth

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes: N/A

Dependents (0)

Package Sidebar

Install

npm i @teemill/file-processor

Weekly Downloads

8

Version

0.3.4

License

Unlicense

Unpacked Size

167 kB

Total Files

42

Last publish

Collaborators

  • devanjs
  • js-wheeler