# API Reference

## `Signal`:

| Name          | Type   | Description                                                                                                                     |
| ------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------- |
| Connect       | Method | <p>Connects a function.<br>​<br><strong>Returns:</strong> <em>Connection</em></p>                                               |
| Once          | Method | <p>Connects a function, then auto-disconnects after the first call.<br>​<br><strong>Returns:</strong> <em>Connection</em></p>   |
| Wait          | Method | Yields the calling thread until the next fire.                                                                                  |
| Fire          | Method | Runs all connected functions and resumes all waiting threads.                                                                   |
| DisconnectAll | Method | <p>Erases all connections.</p><p></p><p><strong>Much faster than calling <code>Disconnect</code> on each.</strong></p>          |
| Destroy       | Method | <p>Erases all connections and methods.</p><p><br><strong>To fully erase, also remove all references to the signal.</strong></p> |

## `Connection`:

| Name       | Type     | Description                                                                                              |
| ---------- | -------- | -------------------------------------------------------------------------------------------------------- |
| Disconnect | Method   | <p>Removes the connection from the signal.</p><p><br><strong>The connection’s data remains.</strong></p> |
| Connected  | Property | A boolean representing the connection state.                                                             |
| Signal     | Property | A reference to the signal the connection is a part of.                                                   |