@enonic-types/lib-app
v7.14.4
Published
Type definitions for lib-app.
Downloads
1,763
Readme
Enonic XP lib-app TS types
TypeScript definitions for
lib-app
library of Enonic XP
Install
npm i --save-dev @enonic-types/lib-app
Use
Add the corresponding types to your tsconfig.json
file that is used for application's server-side TypeScript code.
tsconfig.json
{
"compilerOptions": {
"types": [
"@enonic-types/lib-app"
]
}
}
Require and custom imports
To make require
work out of the box, you must install and add the @enonic-types/global
types. Aside from providing definitions for XP
global objects, e.g. log
, app
, __
, etc, requiring a library by the default path will return typed object.
tsconfig.json
{
"compilerOptions": {
"types": [
"@enonic-types/global"
]
}
}
example.ts
const {
createVirtualApplication,
deleteVirtualApplication,
get,
list,
getDescriptor,
hasVirtual,
hasReal
} = require('/lib/xp/app');
More detailed explanation on how it works and how to type custom import function can be found here.
ES6-style import
If you are planning to use import
in your code and transpile it with the default tsc
TypeScript compiler, you'll need to add proper
types mapping to your configuration.
tsconfig.json
{
"compilerOptions": {
"baseUrl": "./",
"paths": {
"/lib/xp/app": ["node_modules/@enonic-types/lib-app"]
}
}
}
example.ts
import {
createVirtualApplication,
deleteVirtualApplication,
get,
list,
getDescriptor,
hasVirtual,
hasReal
} from '/lib/xp/app';
Setting baseUrl
and paths
will allow the tsc
to keep the valid paths in the resulting JavaScript files.