Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@enonic-types/lib-websocket
Advanced tools
Readme
TypeScript definitions for
lib-websocket
library of Enonic XP
npm i --save-dev @enonic-types/lib-websocket
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 {addToGroup, removeFromGroup, send, sendToGroup, getGroupSize} = require('/lib/xp/websocket');
More detailed explanation on how it works and how to type custom import function can be found here.
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/websocket": ["node_modules/@enonic-types/lib-websocket"]
}
}
}
example.ts
import {addToGroup, removeFromGroup, send, sendToGroup, getGroupSize} from '/lib/xp/websocket';
Setting baseUrl
and paths
will allow the tsc
to keep the valid paths in the resulting JavaScript files.
FAQs
Type definitions for lib-websocket.
The npm package @enonic-types/lib-websocket receives a total of 214 weekly downloads. As such, @enonic-types/lib-websocket popularity was classified as not popular.
We found that @enonic-types/lib-websocket demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 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
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.