next-post-message
- Version 0.0.15
- Published
- 44.2 kB
- No dependencies
- MIT license
Install
npm i next-post-messageyarn add next-post-messagepnpm add next-post-messageOverview
🌳 Tiny & elegant & better windows post message
Index
Classes
class Debugger
class Debugger {}constructor
constructor(enableDebug: boolean, channel?: string);method debug
debug: (...message: any[]) => void;method warn
warn: (...message: any[]) => void;class Handlers
class Handlers<Message, Answer> {}method addHandler
addHandler: (handler: Handler<Message, Answer>) => HandlerId;method handleMessage
handleMessage: ( proxy: ProxyMessagePayload<Message>, options: Options<string>, postMessage: (proxy: ProxyMessagePayload<Answer>) => void) => Promise<void>;method removeHandler
removeHandler: (msgId: HandlerId) => boolean;class NextPostMessage
class NextPostMessage<Message = unknown, Answer = Message | void> {}constructor
constructor(options?: Options<string>);property options
readonly options: Options<string>;method createGetMan
createGetMan: (optionos?: Options) => GetMan<Message, Answer>;method createPostMan
createPostMan: ( targetWindow: Window, PostManOptions?: Options) => PostMan<Message, Answer>;method debug
debug: (...message: any[]) => void;method onReceive
onReceive: (handler: Handler<Message, Answer>) => MessageId;method post
post: ( message: Message, targetWindow?: Window) => { msgId: MessageId; answer: Promise<Answer> };class Npm
class NextPostMessage<Message = unknown, Answer = Message | void> {}constructor
constructor(options?: Options<string>);property options
readonly options: Options<string>;method createGetMan
createGetMan: (optionos?: Options) => GetMan<Message, Answer>;method createPostMan
createPostMan: ( targetWindow: Window, PostManOptions?: Options) => PostMan<Message, Answer>;method debug
debug: (...message: any[]) => void;method onReceive
onReceive: (handler: Handler<Message, Answer>) => MessageId;method post
post: ( message: Message, targetWindow?: Window) => { msgId: MessageId; answer: Promise<Answer> };class Responders
class Responders<Answer> {}constructor
constructor(logger?: Debugger);method addResponder
addResponder: ( proxyID: MessageId, promiseResponder: (res: Answer | PromiseLike<Answer>) => void, promiseRejecter: (reason?: any) => void, timeout: number) => void;method rejectResponders
rejectResponders: (proxyID: MessageId, reason?: any) => void;method resolveResponders
resolveResponders: (proxy: ProxyMessagePayload<Answer>) => void;method setLogger
setLogger: (logger: Debugger) => void;method warn
warn: (...message: any[]) => void;Package Files (1)
Dependencies (0)
No dependencies.
Dev Dependencies (17)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/next-post-message.
- Markdown[](https://www.jsdocs.io/package/next-post-message)
- HTML<a href="https://www.jsdocs.io/package/next-post-message"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3384 ms. - Missing or incorrect documentation? Open an issue for this package.
