Git Product home page Git Product logo

cms-client-api's Introduction

TypeScript-Fetch

This generator creates TypeScript/JavaScript client that utilizes Fetch API. 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)

Installation

swagger-codegen does not generate JavaScript directly. The generated Node module comes with package.json that bundles typescript and typings so it can self-compile during prepublish stage. The should be run automatically during npm install or npm publish.

CAVEAT: Due to privilege implications, npm would skip all scripts if the user is root. You would need to manually run it with npm run prepublish or run npm install --unsafe-perm.

NPM

You may publish the module to NPM. In this case, you would be able to install the module as any other NPM module. It maybe useful to use scoped packages.

You can also use npm link to link the module. However, this would not modify package.json of the installing project, as such you would need to relink every time you deploy that project.

You can also directly install the module using npm install file_path. If you do npm install file_path --save, NPM will save relative path to package.json. In this case, npm install and npm shrinkwrap may misbehave. You would need to manually edit package.json and replace it with absolute path.

Regardless of which method you deployed your NPM module, the ES6 module syntaxes are as follows:

import * as localName from 'npmName';
import {operationId} from 'npmName';

The CommonJS syntax is as follows:

import localName = require('npmName');

Direct copy/symlink

You may also simply copy or symlink the generated module into a directory under your project. The syntax of this is as follows:

With ES6 module syntax, the following syntaxes are supported:

import * as localName from './symlinkDir';
import {operationId} from './symlinkDir';

The CommonJS syntax is as follows:

import localName = require('./symlinkDir')';

cms-client-api's People

Contributors

thurt avatar

Watchers

 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.