Skip to content
Snippets Groups Projects
Select Git revision
  • renovate/configure
  • main default protected
  • 5-add-license
  • v0.1.0 protected
  • v0.1.0-rc1 protected
5 results

api-client-typescript

  • Clone with SSH
  • Clone with HTTPS
  • user avatar
    wvffle authored
    0dd58ffa
    History

    @funkwhale/api@1.2.8

    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 should 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 @funkwhale/api@1.2.8 --save

    unPublished (not recommended):

    npm install PATH_TO_GENERATED_PACKAGE --save