|
entry.js |
Typework will read the entry files, to detect the /* typework */ market which indicates a single block of types which can be managed by the binary (only types within this block will be worked on). |
|
```js
export {}
/* typework */
/**
* @typedef {import('./vendor/cookies').Keygrip} Keygrip
* @typedef {import('./typedefs/application').Middleware} Middleware
* @typedef {import('./typedefs/application').Application} Application
* @typedef {import('./typedefs/context').KoaContext} Context
* @typedef {import('./typedefs/request').Request} Request
* @typedef {import('./typedefs/request').ContextDelegatedRequest} ContextDelegatedRequest
* @typedef {import('./typedefs/response').Response} Response
* @typedef {import('./typedefs/response').ContextDelegatedResponse} ContextDelegatedResponse
*/
```
|
|
index2.js
| The JS file where the types need to be placed, will also contain the /* typework */ marker, but only a single one. It should be at the end and allow for 1 extra line at the end (a file cannot finish with */, only */\n). |
```js
const _Koa = require('./koa')
class Koa extends _Koa {
/**
* Initialize a new `Application`.
*/
constructor() {
super()
}
}
module.exports = Koa
```
Show Typework
```js
/* typework */
/**
* @typedef {import('types/vendor/cookies').Keygrip} Keygrip
* @typedef {import('types/typedefs/application').Middleware} Middleware
* @typedef {import('types/typedefs/application').Application} Application
* @typedef {import('types/typedefs/context').KoaContext} Context
* @typedef {import('types/typedefs/request').Request} Request
* @typedef {import('types/typedefs/request').ContextDelegatedRequest} ContextDelegatedRequest
* @typedef {import('types/typedefs/response').Response} Response
* @typedef {import('types/typedefs/response').ContextDelegatedResponse} ContextDelegatedResponse
*/
```
|
|
types
| The purpose of Typework is to vendor JSDoc across packages easily, so that the IDE documentation can be shown without relying on additional infrastructure like Typings. One of downside of current JSDoc is the lack of import statements, therefore Typework is meant to work in environments which support import. |
|
```m
example/types
├── typedefs
│  ├── application.js
│  ├── context.js
│  ├── request.js
│  └── response.js
└── vendor
├── accepts.js
└── cookies.js
```
|
