Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
egg-ts-helper
Advanced tools
A simple tool for generating declaration files in egg application. Injecting controller
,proxy
,service
and extend
to egg by Declaration Merging
npm i egg-ts-helper -g
or
yarn global add egg-ts-helper
Open your egg application, executing the command
$ ets
-w
flag can auto recreated d.ts while file changed
$ ets -w
$ ets -h
Usage: ets [options]
Options:
-h, --help usage
-v, --version show version
-w, --watch watch file change
-c, --cwd [path] egg application base dir (default: process.cwd)
-C, --config [path] configuration file, The argument can be a file path to a valid JSON/JS configuration file.(default: {cwd}/tshelper.js)
-f, --framework [name] egg framework(default: egg)
-s, --silent disabled log
-i, --ignore [dir] ignore watchDirs, your can ignore multiple dirs with comma like: -i controller,service
-e, --enabled [dir] enabled watchDirs, your can use multiple dirs with comma like: -e proxy,other
-E, --extra [json] extra config, value type was a json string
name | type | default | description |
---|---|---|---|
cwd | string | process.cwd | egg application base dir |
framework | string | egg | egg framework |
typings | string | {cwd}/typings | typings dir |
caseStyle | string | lower | egg case style(lower,upper,camel) |
watch | boolean | false | watch file change or not |
execAtInit | boolean | false | execute d.ts generation while instance was created |
configFile | string | {cwd}/tshelper.js | configure file path |
watchDirs | object | generator configuration |
egg-ts-helper would watching app/extend
,app/controller
,app/service
by default. The dts would recreated when the files under these folders was changed.
you can disabled some folders by -i
flag.
$ ets -i extend,controller
or configure in the config file
// {cwd}/tshelper.js
module.exports = {
watchDirs: {
extend: false,
controller: false,
}
}
or configure in package.json
// {cwd}/package.json
{
"egg": {
"framework": "egg",
"tsHelper": {
"watchDirs": {
"extend": false
}
}
}
}
You can use register to start egg-ts-helper before starting egg application.
$ node -r egg-ts-helper/register index.js
see https://github.com/whxaxes/egg-boilerplate-d-ts
It works in these directories : app/controller
, app/service
, app/proxy
, app/extend
.
(service, proxy are the same)
ts
// app/controller/home.ts
import { Controller } from 'egg';
export default class HomeController extends Controller {
public async index() {
this.ctx.body = 'ok';
}
}
typings
// app/typings/app/controller/index.d.ts
import Home from '../../../app/controller/home';
declare module 'egg' {
interface IController {
home: Home;
}
}
ts
// app/extend/context.ts
export default {
doSomething() {
console.info('do something');
}
};
typings
// app/typings/app/controller/index.d.ts
import ExtendObject from '../../../app/extend/context';
declare module 'egg' {
interface Context {
doSomething: typeof ExtendObject.doSomething;
}
}
FAQs
egg typescript helper
The npm package egg-ts-helper receives a total of 15,911 weekly downloads. As such, egg-ts-helper popularity was classified as popular.
We found that egg-ts-helper demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.