@enonic-types/lib-mail
v7.15.0-A2
Published
Type definitions for lib-mail.
Downloads
2,290
Readme
Enonic XP lib-mail TS types
TypeScript definitions for
lib-mail
library of Enonic XP
Install
npm i --save-dev @enonic-types/lib-mail
Use
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 {send} = require('/lib/xp/mail');
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/mail": ["node_modules/@enonic-types/lib-mail"]
}
}
}
example.ts
import {send} from '/lib/xp/mail';
Setting baseUrl
and paths
will allow the tsc
to keep the valid paths in the resulting JavaScript files.