generated from stagas/ts
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
37 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,36 @@ | ||
| # plugs-and-cables | ||
| <h1> | ||
| plugs-and-cables <a href="https://npmjs.org/package/plugs-and-cables"><img src="https://img.shields.io/badge/npm-v0.0.1-F00.svg?colorA=000"/></a> <a href="src"><img src="https://img.shields.io/badge/loc-76-FFF.svg?colorA=000"/></a> <a href="https://cdn.jsdelivr.net/npm/plugs-and-cables@0.0.1/dist/plugs-and-cables.min.js"><img src="https://img.shields.io/badge/brotli-1.6K-333.svg?colorA=000"/></a> <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-F0B.svg?colorA=000"/></a> | ||
| </h1> | ||
|
|
||
| <p></p> | ||
|
|
||
| Plugs and cables. | ||
|
|
||
| <h4> | ||
| <table><tr><td title="Triple click to select and copy paste"> | ||
| <code>npm i plugs-and-cables </code> | ||
| </td><td title="Triple click to select and copy paste"> | ||
| <code>pnpm add plugs-and-cables </code> | ||
| </td><td title="Triple click to select and copy paste"> | ||
| <code>yarn add plugs-and-cables</code> | ||
| </td></tr></table> | ||
| </h4> | ||
|
|
||
| ## API | ||
|
|
||
| <p> <details id="PlugKind$1" title="Enum" ><summary><span><a href="#PlugKind$1">#</a></span> <code><strong>PlugKind</strong></code> </summary> <a href="src/plugs-and-cables.ts#L4">src/plugs-and-cables.ts#L4</a> <ul> <p> <details id="Input$2" title="EnumMember" ><summary><span><a href="#Input$2">#</a></span> <code><strong>Input</strong></code> <span><span> = </span> <code>"input"</code></span> </summary> <a href="src/plugs-and-cables.ts#L5">src/plugs-and-cables.ts#L5</a> <ul> </ul></details><details id="Output$3" title="EnumMember" ><summary><span><a href="#Output$3">#</a></span> <code><strong>Output</strong></code> <span><span> = </span> <code>"output"</code></span> </summary> <a href="src/plugs-and-cables.ts#L6">src/plugs-and-cables.ts#L6</a> <ul> </ul></details></p></ul></details><details id="Cable$39" title="Class" ><summary><span><a href="#Cable$39">#</a></span> <code><strong>Cable</strong></code> </summary> <a href="src/plugs-and-cables.ts#L62">src/plugs-and-cables.ts#L62</a> <ul> <p> <details id="constructor$40" title="Constructor" ><summary><span><a href="#constructor$40">#</a></span> <code><strong>constructor</strong></code><em>(cable)</em> </summary> <a href="src/plugs-and-cables.ts#L68">src/plugs-and-cables.ts#L68</a> <ul> <p> <details id="new Cable$41" title="ConstructorSignature" ><summary><span><a href="#new Cable$41">#</a></span> <code><strong>new Cable</strong></code><em>()</em> </summary> <ul><p><a href="#Cable$39">Cable</a></p> <p> <details id="cable$42" title="Parameter" ><summary><span><a href="#cable$42">#</a></span> <code><strong>cable</strong></code> </summary> <ul><p><a href="#Cable$39">Cable</a></p> </ul></details></p> </ul></details><details id="new Cable$43" title="ConstructorSignature" ><summary><span><a href="#new Cable$43">#</a></span> <code><strong>new Cable</strong></code><em>()</em> </summary> <ul><p><a href="#Cable$39">Cable</a></p> <p> <details id="outputCh$44" title="Parameter" ><summary><span><a href="#outputCh$44">#</a></span> <code><strong>outputCh</strong></code> </summary> <ul><p>number</p> </ul></details><details id="inputCh$45" title="Parameter" ><summary><span><a href="#inputCh$45">#</a></span> <code><strong>inputCh</strong></code> </summary> <ul><p>number</p> </ul></details></p> </ul></details></p> </ul></details><details id="id$46" title="Property" ><summary><span><a href="#id$46">#</a></span> <code><strong>id</strong></code> <span><span> = </span> <code>...</code></span> </summary> <a href="src/plugs-and-cables.ts#L63">src/plugs-and-cables.ts#L63</a> <ul><p>string</p> </ul></details><details id="inputCh$48" title="Property" ><summary><span><a href="#inputCh$48">#</a></span> <code><strong>inputCh</strong></code> </summary> <a href="src/plugs-and-cables.ts#L66">src/plugs-and-cables.ts#L66</a> <ul><p>number</p> </ul></details><details id="outputCh$47" title="Property" ><summary><span><a href="#outputCh$47">#</a></span> <code><strong>outputCh</strong></code> </summary> <a href="src/plugs-and-cables.ts#L65">src/plugs-and-cables.ts#L65</a> <ul><p>number</p> </ul></details></p></ul></details><details id="Plug$4" title="Class" ><summary><span><a href="#Plug$4">#</a></span> <code><strong>Plug</strong></code> </summary> <a href="src/plugs-and-cables.ts#L9">src/plugs-and-cables.ts#L9</a> <ul> <p> <details id="constructor$7" title="Constructor" ><summary><span><a href="#constructor$7">#</a></span> <code><strong>constructor</strong></code><em>(plug)</em> </summary> <a href="src/plugs-and-cables.ts#L21">src/plugs-and-cables.ts#L21</a> <ul> <p> <details id="new Plug$8" title="ConstructorSignature" ><summary><span><a href="#new Plug$8">#</a></span> <code><strong>new Plug</strong></code><em>()</em> </summary> <ul><p><a href="#Plug$4">Plug</a><<a href="#P$9">P</a>, <a href="#C$10">C</a>></p> <p> <details id="plug$11" title="Parameter" ><summary><span><a href="#plug$11">#</a></span> <code><strong>plug</strong></code> </summary> <ul><p><a href="#Plug$4">Plug</a><<a href="#P$9">P</a>, <a href="#C$10">C</a>></p> </ul></details></p> </ul></details><details id="new Plug$12" title="ConstructorSignature" ><summary><span><a href="#new Plug$12">#</a></span> <code><strong>new Plug</strong></code><em>()</em> </summary> <ul><p><a href="#Plug$4">Plug</a><<a href="#P$9">P</a>, <a href="#C$10">C</a>></p> <p> <details id="plugKind$15" title="Parameter" ><summary><span><a href="#plugKind$15">#</a></span> <code><strong>plugKind</strong></code> </summary> <ul><p><a href="#Plug$4">Plug</a><<a href="#P$9">P</a>, <a href="#C$10">C</a>> | <a href="#P$9">P</a></p> </ul></details><details id="cableKind$16" title="Parameter" ><summary><span><a href="#cableKind$16">#</a></span> <code><strong>cableKind</strong></code> </summary> <ul><p><a href="#C$10">C</a></p> </ul></details></p> </ul></details></p> </ul></details><details id="cableKind$18" title="Property" ><summary><span><a href="#cableKind$18">#</a></span> <code><strong>cableKind</strong></code> </summary> <a href="src/plugs-and-cables.ts#L14">src/plugs-and-cables.ts#L14</a> <ul><p><a href="#C$10">C</a></p> </ul></details><details id="cables$19" title="Property" ><summary><span><a href="#cables$19">#</a></span> <code><strong>cables</strong></code> <span><span> = </span> <code>...</code></span> </summary> <a href="src/plugs-and-cables.ts#L16">src/plugs-and-cables.ts#L16</a> <ul><p><span>Map</span><<a href="#Cable$39">Cable</a>, <a href="#Plug$4">Plug</a><<a href="#P$9">P</a> extends <a href="#Output$3">Output</a> ? <a href="#Input$2">Input</a> : <a href="#Output$3">Output</a>, <a href="#C$10">C</a>>></p> </ul></details><details id="onconnect$20" title="Property" ><summary><span><a href="#onconnect$20">#</a></span> <code><strong>onconnect</strong></code> </summary> <a href="src/plugs-and-cables.ts#L18">src/plugs-and-cables.ts#L18</a> <ul><p><span>EventHandler</span><<a href="#Plug$4">Plug</a><any, any>, <span>CustomEvent</span><{<p> <details id="cable$22" title="Property" ><summary><span><a href="#cable$22">#</a></span> <code><strong>cable</strong></code> </summary> <a href="src/plugs-and-cables.ts#L18">src/plugs-and-cables.ts#L18</a> <ul><p><a href="#Cable$39">Cable</a></p> </ul></details><details id="plug$23" title="Property" ><summary><span><a href="#plug$23">#</a></span> <code><strong>plug</strong></code> </summary> <a href="src/plugs-and-cables.ts#L18">src/plugs-and-cables.ts#L18</a> <ul><p><a href="#Plug$4">Plug</a><any, any></p> </ul></details></p>}>></p> </ul></details><details id="ondisconnect$24" title="Property" ><summary><span><a href="#ondisconnect$24">#</a></span> <code><strong>ondisconnect</strong></code> </summary> <a href="src/plugs-and-cables.ts#L19">src/plugs-and-cables.ts#L19</a> <ul><p><span>EventHandler</span><<a href="#Plug$4">Plug</a><any, any>, <span>CustomEvent</span><{<p> <details id="cable$26" title="Property" ><summary><span><a href="#cable$26">#</a></span> <code><strong>cable</strong></code> </summary> <a href="src/plugs-and-cables.ts#L19">src/plugs-and-cables.ts#L19</a> <ul><p><a href="#Cable$39">Cable</a></p> </ul></details><details id="plug$27" title="Property" ><summary><span><a href="#plug$27">#</a></span> <code><strong>plug</strong></code> </summary> <a href="src/plugs-and-cables.ts#L19">src/plugs-and-cables.ts#L19</a> <ul><p><a href="#Plug$4">Plug</a><any, any></p> </ul></details></p>}>></p> </ul></details><details id="plugKind$17" title="Property" ><summary><span><a href="#plugKind$17">#</a></span> <code><strong>plugKind</strong></code> </summary> <a href="src/plugs-and-cables.ts#L13">src/plugs-and-cables.ts#L13</a> <ul><p><a href="#P$9">P</a></p> </ul></details><details id="Input$6" title="Property" ><summary><span><a href="#Input$6">#</a></span> <code><strong>Input</strong></code> <span><span> = </span> <code>...</code></span> </summary> <a href="src/plugs-and-cables.ts#L11">src/plugs-and-cables.ts#L11</a> <ul><p><a href="#Input$2">Input</a></p> </ul></details><details id="Output$5" title="Property" ><summary><span><a href="#Output$5">#</a></span> <code><strong>Output</strong></code> <span><span> = </span> <code>...</code></span> </summary> <a href="src/plugs-and-cables.ts#L10">src/plugs-and-cables.ts#L10</a> <ul><p><a href="#Output$3">Output</a></p> </ul></details><details id="connect$28" title="Method" ><summary><span><a href="#connect$28">#</a></span> <code><strong>connect</strong></code><em>(this, other, cable)</em> </summary> <a href="src/plugs-and-cables.ts#L41">src/plugs-and-cables.ts#L41</a> <ul> <p> <details id="this$30" title="Parameter" ><summary><span><a href="#this$30">#</a></span> <code><strong>this</strong></code> </summary> <ul><p><a href="#Plug$4">Plug</a><any, any></p> </ul></details><details id="other$31" title="Parameter" ><summary><span><a href="#other$31">#</a></span> <code><strong>other</strong></code> </summary> <ul><p><a href="#Plug$4">Plug</a><any, any></p> </ul></details><details id="cable$32" title="Parameter" ><summary><span><a href="#cable$32">#</a></span> <code><strong>cable</strong></code> <span><span> = </span> <code>...</code></span> </summary> <ul><p><a href="#Cable$39">Cable</a></p> </ul></details> <p><strong>connect</strong><em>(this, other, cable)</em> => <ul><a href="#Cable$39">Cable</a></ul></p></p> </ul></details><details id="disconnect$33" title="Method" ><summary><span><a href="#disconnect$33">#</a></span> <code><strong>disconnect</strong></code><em>(this, cable)</em> </summary> <a href="src/plugs-and-cables.ts#L49">src/plugs-and-cables.ts#L49</a> <ul> <p> <details id="this$35" title="Parameter" ><summary><span><a href="#this$35">#</a></span> <code><strong>this</strong></code> </summary> <ul><p><a href="#Plug$4">Plug</a><any, any></p> </ul></details><details id="cable$36" title="Parameter" ><summary><span><a href="#cable$36">#</a></span> <code><strong>cable</strong></code> </summary> <ul><p><a href="#Cable$39">Cable</a></p> </ul></details> <p><strong>disconnect</strong><em>(this, cable)</em> => <ul><a href="#Cable$39">Cable</a></ul></p></p> </ul></details></p></ul></details></p> | ||
|
|
||
| ## Credits | ||
|
|
||
| - [event-toolkit](https://npmjs.org/package/event-toolkit) by [stagas](https://github.com/stagas) – Toolkit for DOM events. | ||
| - [everyday-utils](https://npmjs.org/package/everyday-utils) by [stagas](https://github.com/stagas) – Everyday utilities | ||
|
|
||
| ## Contributing | ||
|
|
||
| [Fork](https://github.com/stagas/plugs-and-cables/fork) or [edit](https://github.dev/stagas/plugs-and-cables) and submit a PR. | ||
|
|
||
| All contributions are welcome! | ||
|
|
||
| ## License | ||
|
|
||
| <a href="LICENSE">MIT</a> © 2022 [stagas](https://github.com/stagas) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters