bariscicek / gulp-loopback-typescript

Loopback model typescript definition generator plugin for gulp.

gulp-loopback-typescript

Typescript definition file generator plugin for gulp.

to install gulp-loopback-typescript

npm install --save-dev gulp-loopback-typescript

to use gulp-loopback-typescript

import { loopbackTypescript } from "gulp-loopback-typescript";

// in ES5
var loopbackTypescript = require("gulp-loopback-typescript");

gulp.task("loopbackTypescript", () =>
    return gulp.src("common/models/*json")
              .pipe(loopbackTypescript({
                // dest: "node_modules/@types/loopback",
                // modelDir: "src/typescript/common/models"
              }));
);

Plugin updates @types/loopback/index.d.ts file with the model definition data of each model exists in modelDir option.

Note: If typings definition file of loopback exists that file will be updated, otherwise plugin copy will be replaced.

Known bugs:

• Properties with "type" name causes problem (ie. { "type": { "type": "string" }})

Todo:

• model methods
• relations
• handling default values

gulp-loopback-typescript's Issues

"type" as name is treated as a "type"

When using "type" as a name in format of "type": "String", it is not treated as a sub object. Checking of existance of "type", should handle "type": { "type": "String" } for correct behaviour.

Nested objects do not generate interfaces

When objects are nested down, sub object interfaces are not created. A definition like

"name": {
   "subName": {
            "foo": "bar"
   }
}

Is only creating IName interface, not ISubName interface.