IcyNetwork/irclib
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tweak readme

Browse Source
This commit is contained in:
Evert Prants 2022-09-24 14:31:11 +03:00
parent 877d3caa9c
commit ad68321e8b
Signed by: evert
GPG Key ID: 1688DA83D222D0B5
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -25,14 +25,14 @@ The connection options are documented in detail [here](https://lunasqu.ee/irclib
This module provides two connectors: `IRCSocketConnector` for Node.js usage (`net` and `tls`) and `IRCWebSocketConnector` for browser usage (WebSockets). You can always write your own if you need something different. This module provides two connectors: `IRCSocketConnector` for Node.js usage (`net` and `tls`) and `IRCWebSocketConnector` for browser usage (WebSockets). You can always write your own if you need something different.
**These are not included in the main module!** You need to import them from `@icynet/irclib/lib/connector/[..].ts`. This is to prevent browser bundlers from including `net` and `tls`! **These are not included in the main module!** You need to import them from `@icynet/irclib/lib/connector/[..]`. This is to prevent browser bundlers from including `net` and `tls`!
### Event handlers ### Event handlers
The main classes use a special custom [TypedEventEmitter](https://lunasqu.ee/irclib/classes/TypedEventEmitter.html) to send events. The main classes use a special custom [TypedEventEmitter](https://lunasqu.ee/irclib/classes/TypedEventEmitter.html) to send events.
- [Connection wrapper events](https://lunasqu.ee/irclib/classes/IRCConnectionWrapper.html) - [Connection wrapper events](https://lunasqu.ee/irclib/types/IRCCommunicatorEvents.html)
- [Nick list events](https://lunasqu.ee/irclib/classes/IRCNickList.html) - [Nick list events](https://lunasqu.ee/irclib/types/NickListEvents.html)
Basically, you're mostly just going to need the `message` event for IRC. Basically, you're mostly just going to need the `message` event for IRC.

1
src/index.ts
View File

@ -15,6 +15,7 @@ export * from './utility/typed-event-emitter';
export * from './utility/truncate'; export * from './utility/truncate';
export * from './utility/user-mapper'; export * from './utility/user-mapper';
export * from './utility/whois-parser'; export * from './utility/whois-parser';
export * from './utility/who-parser';
export * from './spec/command-replies'; export * from './spec/command-replies';
export * from './spec/error-replies'; export * from './spec/error-replies';