diff --git a/packages/js/docs/ts/README.md b/packages/js/docs/ts/README.md index c0d7ee5b..f44b9f2a 100644 --- a/packages/js/docs/ts/README.md +++ b/packages/js/docs/ts/README.md @@ -1,20 +1,18 @@ -# @telnyx/webrtc - ## Table of contents ### Call Classes -- [Call](classes/Call.md) +- [Call](./classes/Call.md) ### Client Classes -- [TelnyxRTC](classes/TelnyxRTC.md) +- [TelnyxRTC](./classes/TelnyxRTC.md) ### Notification Interfaces -- [INotification](interfaces/INotification.md) +- [INotification](./interfaces/INotification.md) ### Other Interfaces -- [ICallOptions](interfaces/ICallOptions.md) -- [IClientOptions](interfaces/IClientOptions.md) +- [ICallOptions](./interfaces/ICallOptions.md) +- [IClientOptions](./interfaces/IClientOptions.md) diff --git a/packages/js/docs/ts/classes/Call.md b/packages/js/docs/ts/classes/Call.md index 40ffd720..94b739c8 100644 --- a/packages/js/docs/ts/classes/Call.md +++ b/packages/js/docs/ts/classes/Call.md @@ -1,5 +1,3 @@ -# Class: Call - A `Call` is the representation of an audio or video call between two browsers, SIP clients or phone numbers. The `call` object is created whenever a new call is initiated, either by you or the @@ -54,37 +52,37 @@ call.muteAudio(); ### Properties -- [direction](Call.md#direction) -- [id](Call.md#id) -- [prevState](Call.md#prevstate) -- [state](Call.md#state) +- [direction](./classes/Call.md#direction) +- [id](./classes/Call.md#id) +- [prevState](./classes/Call.md#prevstate) +- [state](./classes/Call.md#state) ### Accessors -- [localStream](Call.md#localstream) -- [remoteStream](Call.md#remotestream) -- [telnyxIDs](Call.md#telnyxids) +- [localStream](./classes/Call.md#localstream) +- [remoteStream](./classes/Call.md#remotestream) +- [telnyxIDs](./classes/Call.md#telnyxids) ### Methods -- [answer](Call.md#answer) -- [deaf](Call.md#deaf) -- [dtmf](Call.md#dtmf) -- [getStats](Call.md#getstats) -- [hold](Call.md#hold) -- [muteAudio](Call.md#muteaudio) -- [muteVideo](Call.md#mutevideo) -- [setAudioInDevice](Call.md#setaudioindevice) -- [setAudioOutDevice](Call.md#setaudiooutdevice) -- [setVideoDevice](Call.md#setvideodevice) -- [toggleAudioMute](Call.md#toggleaudiomute) -- [toggleDeaf](Call.md#toggledeaf) -- [toggleHold](Call.md#togglehold) -- [toggleVideoMute](Call.md#togglevideomute) -- [undeaf](Call.md#undeaf) -- [unhold](Call.md#unhold) -- [unmuteAudio](Call.md#unmuteaudio) -- [unmuteVideo](Call.md#unmutevideo) +- [answer](./classes/Call.md#answer) +- [deaf](./classes/Call.md#deaf) +- [dtmf](./classes/Call.md#dtmf) +- [getStats](./classes/Call.md#getstats) +- [hold](./classes/Call.md#hold) +- [muteAudio](./classes/Call.md#muteaudio) +- [muteVideo](./classes/Call.md#mutevideo) +- [setAudioInDevice](./classes/Call.md#setaudioindevice) +- [setAudioOutDevice](./classes/Call.md#setaudiooutdevice) +- [setVideoDevice](./classes/Call.md#setvideodevice) +- [toggleAudioMute](./classes/Call.md#toggleaudiomute) +- [toggleDeaf](./classes/Call.md#toggledeaf) +- [toggleHold](./classes/Call.md#togglehold) +- [toggleVideoMute](./classes/Call.md#togglevideomute) +- [undeaf](./classes/Call.md#undeaf) +- [unhold](./classes/Call.md#unhold) +- [unmuteAudio](./classes/Call.md#unmuteaudio) +- [unmuteVideo](./classes/Call.md#unmutevideo) ## Properties diff --git a/packages/js/docs/ts/classes/TelnyxRTC.md b/packages/js/docs/ts/classes/TelnyxRTC.md index b81792ec..ac66d366 100644 --- a/packages/js/docs/ts/classes/TelnyxRTC.md +++ b/packages/js/docs/ts/classes/TelnyxRTC.md @@ -1,5 +1,3 @@ -# Class: TelnyxRTC - The `TelnyxRTC` client connects your application to the Telnyx backend, enabling you to make outgoing calls and handle incoming calls. @@ -44,15 +42,15 @@ client.off('telnyx.notification'); ### Constructors -- [constructor](TelnyxRTC.md#constructor) +- [constructor](./classes/TelnyxRTC.md#constructor) ### Accessors -- [connected](TelnyxRTC.md#connected) -- [localElement](TelnyxRTC.md#localelement) -- [mediaConstraints](TelnyxRTC.md#mediaconstraints) -- [remoteElement](TelnyxRTC.md#remoteelement) -- [speaker](TelnyxRTC.md#speaker) +- [connected](./classes/TelnyxRTC.md#connected) +- [localElement](./classes/TelnyxRTC.md#localelement) +- [mediaConstraints](./classes/TelnyxRTC.md#mediaconstraints) +- [remoteElement](./classes/TelnyxRTC.md#remoteelement) +- [speaker](./classes/TelnyxRTC.md#speaker) ### Methods @@ -89,9 +87,9 @@ Creates a new `TelnyxRTC` instance with the provided options. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`IClientOptions`](../interfaces/IClientOptions.md) | Options for initializing a client | +| Name | Type | Description | +| :-------- | :------------------------------------------------- | :-------------------------------- | +| `options` | [`IClientOptions`](./interfaces/IClientOptions.md) | Options for initializing a client | **`Examples`** @@ -170,7 +168,7 @@ console.log(client.connected); // => false TelnyxRTCClient.connected -___ +--- ### localElement @@ -201,8 +199,8 @@ Sets the local html element that will receive the local stream. #### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :---- | :------------------------------------------- | | `tag` | `string` \| `Function` \| `HTMLMediaElement` | #### Returns @@ -220,7 +218,7 @@ client.localElement = 'localElementMediaId'; TelnyxRTCClient.localElement -___ +--- ### mediaConstraints @@ -232,8 +230,8 @@ Audio and video constraints currently used by the client. `Object` -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------ | :----------------------------------- | | `audio` | `boolean` \| `MediaTrackConstraints` | | `video` | `boolean` \| `MediaTrackConstraints` | @@ -250,7 +248,7 @@ console.log(client.mediaConstraints); TelnyxRTCClient.mediaConstraints -___ +--- ### remoteElement @@ -281,8 +279,8 @@ Sets the remote html element that will receive the remote stream. #### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :---- | :------------------------------------------- | | `tag` | `string` \| `Function` \| `HTMLMediaElement` | #### Returns @@ -300,7 +298,7 @@ client.remoteElement = 'remoteElementMediaId'; TelnyxRTCClient.remoteElement -___ +--- ### speaker @@ -331,8 +329,8 @@ Sets the default audio output device for subsequent calls. #### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :--------- | :------- | | `deviceId` | `string` | #### Returns @@ -363,10 +361,10 @@ Checks if the browser has the permission to access mic and/or webcam #### Parameters -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `audio` | `boolean` | `true` | Whether to check for microphone permissions. | -| `video` | `boolean` | `true` | Whether to check for webcam permissions. | +| Name | Type | Default value | Description | +| :------ | :-------- | :------------ | :------------------------------------------- | +| `audio` | `boolean` | `true` | Whether to check for microphone permissions. | +| `video` | `boolean` | `true` | Whether to check for webcam permissions. | #### Returns @@ -402,7 +400,7 @@ client.checkPermissions(false, true); TelnyxRTCClient.checkPermissions -___ +--- ### connect @@ -426,7 +424,7 @@ client.connect(); TelnyxRTCClient.connect -___ +--- ### disableMicrophone @@ -457,7 +455,7 @@ specified before disabling the microphone. ```js const client = new TelnyxRTC({ ...options, - video: true + video: true, }); client.disableMicrophone(); @@ -467,7 +465,7 @@ client.disableMicrophone(); TelnyxRTCClient.disableMicrophone -___ +--- ### disableWebcam @@ -492,7 +490,7 @@ client.disableWebcam(); ```js const client = new TelnyxRTC({ ...options, - video: true + video: true, }); client.disableWebcam(); @@ -502,7 +500,7 @@ client.disableWebcam(); TelnyxRTCClient.disableWebcam -___ +--- ### disconnect @@ -526,7 +524,7 @@ client.disconnect(); TelnyxRTCClient.disconnect -___ +--- ### enableMicrophone @@ -553,7 +551,7 @@ client.enableMicrophone(); TelnyxRTCClient.enableMicrophone -___ +--- ### enableWebcam @@ -580,7 +578,7 @@ client.enableWebcam(); TelnyxRTCClient.enableWebcam -___ +--- ### getAudioInDevices @@ -620,7 +618,7 @@ client.getAudioInDevices().then((result) => { TelnyxRTCClient.getAudioInDevices -___ +--- ### getAudioOutDevices @@ -665,7 +663,7 @@ client.getAudioOutDevices().then((result) => { TelnyxRTCClient.getAudioOutDevices -___ +--- ### getDeviceResolutions @@ -675,8 +673,8 @@ Returns supported resolution for the given webcam. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | +| Name | Type | Description | +| :--------- | :------- | :------------------------------- | | `deviceId` | `string` | the `deviceId` from your webcam. | #### Returns @@ -688,10 +686,10 @@ Returns supported resolution for the given webcam. If `deviceId` is `null` 1. if `deviceId` is `null` and you don't have a webcam connected to your computer, -it will throw an error with the message `"Requested device not found"`. + it will throw an error with the message `"Requested device not found"`. 2. if `deviceId` is `null` and you have one or more webcam connected to your computer, -it will return a list of resolutions from the default device set up in your operating system. + it will return a list of resolutions from the default device set up in your operating system. Using async/await: @@ -737,7 +735,7 @@ client.getDeviceResolutions(deviceId).then((result) => { TelnyxRTCClient.getDeviceResolutions -___ +--- ### getDevices @@ -773,7 +771,7 @@ client.getDevices().then((result) => { TelnyxRTCClient.getDevices -___ +--- ### getIsRegistered @@ -791,7 +789,7 @@ Promise TelnyxRTCClient.getIsRegistered -___ +--- ### getVideoDevices @@ -829,7 +827,7 @@ client.getVideoDevices().then((result) => { TelnyxRTCClient.getVideoDevices -___ +--- ### logout @@ -847,23 +845,23 @@ Alias for .disconnect() TelnyxRTCClient.logout -___ +--- ### newCall -▸ **newCall**(`options`): [`Call`](Call.md) +▸ **newCall**(`options`): [`Call`](./classes/Call.md) Makes a new outbound call. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`ICallOptions`](../interfaces/ICallOptions.md) | Options object for a new call. | +| Name | Type | Description | +| :-------- | :--------------------------------------------- | :----------------------------- | +| `options` | [`ICallOptions`](./interfaces/ICallOptions.md) | Options object for a new call. | #### Returns -[`Call`](Call.md) +[`Call`](./classes/Call.md) The new outbound `Call` object. @@ -874,7 +872,7 @@ Making an outbound call to `+1 856-444-0362` using default values from the clien ```js const call = client.newCall({ destinationNumber: '+18564440362', - callerNumber: '+15551231234' + callerNumber: '+15551231234', }); ``` @@ -882,7 +880,7 @@ You can omit `callerNumber` when dialing a SIP address: ```js const call = client.newCall({ - destinationNumber: 'sip:example-sip-username@voip-provider.example.net' + destinationNumber: 'sip:example-sip-username@voip-provider.example.net', }); ``` @@ -890,7 +888,7 @@ If you are making calls from one Telnyx connection to another, you may specify j ```js const call = client.newCall({ - destinationNumber: 'telnyx-sip-username' // This is equivalent to 'sip:telnyx-sip-username@sip.telnyx.com' + destinationNumber: 'telnyx-sip-username', // This is equivalent to 'sip:telnyx-sip-username@sip.telnyx.com' }); ``` @@ -907,25 +905,25 @@ const call = client.newCall().catch(console.error); TelnyxRTCClient.newCall -___ +--- ### off -▸ **off**(`eventName`, `callback?`): [`TelnyxRTC`](TelnyxRTC.md) +▸ **off**(`eventName`, `callback?`): [`TelnyxRTC`](./classes/TelnyxRTC.md) Removes an event handler that were attached with .on(). If no handler parameter is passed, all listeners for that event will be removed. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` | Event name. | +| Name | Type | Description | +| :---------- | :--------- | :------------------------------ | +| `eventName` | `string` | Event name. | | `callback?` | `Function` | Function handler to be removed. | #### Returns -[`TelnyxRTC`](TelnyxRTC.md) +[`TelnyxRTC`](./classes/TelnyxRTC.md) The client object itself. @@ -938,50 +936,51 @@ Subscribe to the `telnyx.error` and then, remove the event handler. ```js const errorHandler = (error) => { - // Log the error.. -} + // Log the error.. +}; const client = new TelnyxRTC(options); -client.on('telnyx.error', errorHandler) +client.on('telnyx.error', errorHandler); - // .. later -client.off('telnyx.error', errorHandler) +// .. later +client.off('telnyx.error', errorHandler); ``` #### Inherited from TelnyxRTCClient.off -___ +--- ### on -▸ **on**(`eventName`, `callback`): [`TelnyxRTC`](TelnyxRTC.md) +▸ **on**(`eventName`, `callback`): [`TelnyxRTC`](./classes/TelnyxRTC.md) Attaches an event handler for a specific type of event. ### Events -| | | -|---|---| -| `telnyx.ready` | The client is authenticated and available to use | -| `telnyx.error` | An error occurred at the session level | -| `telnyx.notification` | An update to the call or session | -| `telnyx.socket.open` | The WebSocket connection has been made | -| `telnyx.socket.close` | The WebSocket connection is set to close | -| `telnyx.socket.error` | An error occurred at the WebSocket level | + +| | | +| ----------------------- | ---------------------------------------------------- | +| `telnyx.ready` | The client is authenticated and available to use | +| `telnyx.error` | An error occurred at the session level | +| `telnyx.notification` | An update to the call or session | +| `telnyx.socket.open` | The WebSocket connection has been made | +| `telnyx.socket.close` | The WebSocket connection is set to close | +| `telnyx.socket.error` | An error occurred at the WebSocket level | | `telnyx.socket.message` | The client has received a message through WebSockets | #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` | Event name. | -| `callback` | `Function` | Function to call when the event comes. | +| Name | Type | Description | +| :---------- | :--------- | :------------------------------------- | +| `eventName` | `string` | Event name. | +| `callback` | `Function` | Function to call when the event comes. | #### Returns -[`TelnyxRTC`](TelnyxRTC.md) +[`TelnyxRTC`](./classes/TelnyxRTC.md) The client object itself. @@ -992,18 +991,20 @@ Subscribe to the `telnyx.ready` and `telnyx.error` events. ```js const client = new TelnyxRTC(options); -client.on('telnyx.ready', (client) => { - // Your client is ready! -}).on('telnyx.error', (error) => { - // Got an error... -}) +client + .on('telnyx.ready', (client) => { + // Your client is ready! + }) + .on('telnyx.error', (error) => { + // Got an error... + }); ``` #### Inherited from TelnyxRTCClient.on -___ +--- ### onNetworkClose @@ -1021,7 +1022,7 @@ void TelnyxRTCClient.onNetworkClose -___ +--- ### setAudioSettings @@ -1039,8 +1040,8 @@ by matching both id and label with the device list retrieved from the browser. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | +| Name | Type | Description | +| :--------- | :--------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | | `settings` | `IAudioSettings` | [MediaTrackConstraints](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints) object with the addition of `micId` and `micLabel`. | #### Returns @@ -1056,17 +1057,17 @@ Set microphone by `id` and `label` with the `echoCancellation` flag turned off: ```js // within an async function const constraints = await client.setAudioSettings({ - micId: '772e94959e12e589b1cc71133d32edf543d3315cfd1d0a4076a60601d4ff4df8', - micLabel: 'Internal Microphone (Built-in)', - echoCancellation: false -}) + micId: '772e94959e12e589b1cc71133d32edf543d3315cfd1d0a4076a60601d4ff4df8', + micLabel: 'Internal Microphone (Built-in)', + echoCancellation: false, +}); ``` #### Inherited from TelnyxRTCClient.setAudioSettings -___ +--- ### setVideoSettings @@ -1084,8 +1085,8 @@ by matching both `id` and `label` with the device list retrieved from the browse #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | +| Name | Type | Description | +| :--------- | :--------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | | `settings` | `IVideoSettings` | [MediaTrackConstraints](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints) object with the addition of `camId` and `camLabel`. | #### Returns @@ -1101,18 +1102,18 @@ Set webcam by `id` and `label` with 720p resolution. ```js // within an async function const constraints = await client.setVideoSettings({ - camId: '882e94959e12e589b1cc71133d32edf543d3315cfd1d0a4076a60601d4ff4df8', - camLabel: 'Default WebCam (Built-in)', - width: 1080, - height: 720 -}) + camId: '882e94959e12e589b1cc71133d32edf543d3315cfd1d0a4076a60601d4ff4df8', + camLabel: 'Default WebCam (Built-in)', + width: 1080, + height: 720, +}); ``` #### Inherited from TelnyxRTCClient.setVideoSettings -___ +--- ### webRTCInfo @@ -1143,11 +1144,11 @@ An error message will be returned if your browser doesn't support TelnyxRTC ```js const info = TelnyxRTC.webRTCInfo(); if (!info.supportWebRTC) { - console.error(info) // => 'This browser does not support @telnyx/webrtc. To see browser support list: `TelnyxRTC.webRTCSupportedBrowserList()' + console.error(info); // => 'This browser does not support @telnyx/webrtc. To see browser support list: `TelnyxRTC.webRTCSupportedBrowserList()' } ``` -___ +--- ### webRTCSupportedBrowserList @@ -1159,14 +1160,15 @@ The following table indicates the browsers supported by TelnyxRTC. We support the most recent (N) versions of these browsers unless otherwise indicated. | | Chrome | Firefox | Safari | Edge | -|---------|--------|---------|--------|------| -| Android | [-] | [-] | [ ] | [ ] | -| iOS | [ ] | [ ] | [x] | [ ] | -| Linux | [x] | [-] | [ ] | [ ] | -| MacOS | [x] | [-] | [x] | [-] | -| Windows | [x] | [-] | [ ] | [-] | +| ------- | ------ | ------- | ------ | ---- | +| Android | [-] | [-] | [ ] | [ ] | +| iOS | [ ] | [ ] | [x] | [ ] | +| Linux | [x] | [-] | [ ] | [ ] | +| MacOS | [x] | [-] | [x] | [-] | +| Windows | [x] | [-] | [ ] | [-] | #### Legend + [x] supports audio and video [-] supports only audio [ ] not supported @@ -1181,5 +1183,5 @@ An array with supported operational systems and browsers. ```js const browserList = TelnyxRTC.webRTCSupportedBrowserList(); -console.log(browserList) // => [{"operationSystem": "Android", "supported": [{"browserName": "Chrome", "features": ["video", "audio"], "supported": "full"},{...}] +console.log(browserList); // => [{"operationSystem": "Android", "supported": [{"browserName": "Chrome", "features": ["video", "audio"], "supported": "full"},{...}] ``` diff --git a/packages/js/docs/ts/interfaces/ICallOptions.md b/packages/js/docs/ts/interfaces/ICallOptions.md index 91cd0c21..005ca1a1 100644 --- a/packages/js/docs/ts/interfaces/ICallOptions.md +++ b/packages/js/docs/ts/interfaces/ICallOptions.md @@ -1,5 +1,3 @@ -# Interface: ICallOptions - ICallOptions ICallOptions @@ -7,31 +5,31 @@ ICallOptions ### Properties -- [audio](ICallOptions.md#audio) -- [callerName](ICallOptions.md#callername) -- [callerNumber](ICallOptions.md#callernumber) -- [camId](ICallOptions.md#camid) -- [clientState](ICallOptions.md#clientstate) -- [customHeaders](ICallOptions.md#customheaders) -- [debug](ICallOptions.md#debug) -- [debugOutput](ICallOptions.md#debugoutput) -- [destinationNumber](ICallOptions.md#destinationnumber) -- [iceServers](ICallOptions.md#iceservers) -- [id](ICallOptions.md#id) -- [localElement](ICallOptions.md#localelement) -- [localStream](ICallOptions.md#localstream) -- [mediaSettings](ICallOptions.md#mediasettings) -- [micId](ICallOptions.md#micid) -- [onNotification](ICallOptions.md#onnotification) -- [preferred\_codecs](ICallOptions.md#preferred_codecs) -- [remoteElement](ICallOptions.md#remoteelement) -- [remoteStream](ICallOptions.md#remotestream) -- [speakerId](ICallOptions.md#speakerid) -- [telnyxCallControlId](ICallOptions.md#telnyxcallcontrolid) -- [telnyxLegId](ICallOptions.md#telnyxlegid) -- [telnyxSessionId](ICallOptions.md#telnyxsessionid) -- [useStereo](ICallOptions.md#usestereo) -- [video](ICallOptions.md#video) +- [audio](./interfaces/ICallOptions.md#audio) +- [callerName](./interfaces/ICallOptions.md#callername) +- [callerNumber](./interfaces/ICallOptions.md#callernumber) +- [camId](./interfaces/ICallOptions.md#camid) +- [clientState](./interfaces/ICallOptions.md#clientstate) +- [customHeaders](./interfaces/ICallOptions.md#customheaders) +- [debug](./interfaces/ICallOptions.md#debug) +- [debugOutput](./interfaces/ICallOptions.md#debugoutput) +- [destinationNumber](./interfaces/ICallOptions.md#destinationnumber) +- [iceServers](./interfaces/ICallOptions.md#iceservers) +- [id](./interfaces/ICallOptions.md#id) +- [localElement](./interfaces/ICallOptions.md#localelement) +- [localStream](./interfaces/ICallOptions.md#localstream) +- [mediaSettings](./interfaces/ICallOptions.md#mediasettings) +- [micId](./interfaces/ICallOptions.md#micid) +- [onNotification](./interfaces/ICallOptions.md#onnotification) +- [preferred\_codecs](./interfaces/ICallOptions.md#preferred_codecs) +- [remoteElement](./interfaces/ICallOptions.md#remoteelement) +- [remoteStream](./interfaces/ICallOptions.md#remotestream) +- [speakerId](./interfaces/ICallOptions.md#speakerid) +- [telnyxCallControlId](./interfaces/ICallOptions.md#telnyxcallcontrolid) +- [telnyxLegId](./interfaces/ICallOptions.md#telnyxlegid) +- [telnyxSessionId](./interfaces/ICallOptions.md#telnyxsessionid) +- [useStereo](./interfaces/ICallOptions.md#usestereo) +- [video](./interfaces/ICallOptions.md#video) ## Properties diff --git a/packages/js/docs/ts/interfaces/IClientOptions.md b/packages/js/docs/ts/interfaces/IClientOptions.md index 0e73f389..d0ffe00f 100644 --- a/packages/js/docs/ts/interfaces/IClientOptions.md +++ b/packages/js/docs/ts/interfaces/IClientOptions.md @@ -1,5 +1,3 @@ -# Interface: IClientOptions - IClientOptions IClientOptions @@ -7,11 +5,11 @@ IClientOptions ### Properties -- [login](IClientOptions.md#login) -- [login\_token](IClientOptions.md#login_token) -- [password](IClientOptions.md#password) -- [ringbackFile](IClientOptions.md#ringbackfile) -- [ringtoneFile](IClientOptions.md#ringtonefile) +- [login](./interfaces/IClientOptions.md#login) +- [login\_token](./interfaces/IClientOptions.md#login_token) +- [password](./interfaces/IClientOptions.md#password) +- [ringbackFile](./interfaces/IClientOptions.md#ringbackfile) +- [ringtoneFile](./interfaces/IClientOptions.md#ringtonefile) ## Properties diff --git a/packages/js/docs/ts/interfaces/INotification.md b/packages/js/docs/ts/interfaces/INotification.md index 81fcc55f..2a2c1d75 100644 --- a/packages/js/docs/ts/interfaces/INotification.md +++ b/packages/js/docs/ts/interfaces/INotification.md @@ -1,5 +1,3 @@ -# Interface: INotification - An event dispatched by Telnyx to notify the client of changes to the session or call. The conditions of the event can be identified by the `type` property. @@ -62,9 +60,9 @@ Notification ### Properties -- [call](INotification.md#call) -- [error](INotification.md#error) -- [type](INotification.md#type) +- [call](./interfaces/INotification.md#call) +- [error](./interfaces/INotification.md#error) +- [type](./interfaces/INotification.md#type) ## Properties diff --git a/packages/js/typedoc.json b/packages/js/typedoc.json index b6b2368d..0f176941 100644 --- a/packages/js/typedoc.json +++ b/packages/js/typedoc.json @@ -13,11 +13,14 @@ "excludePrivate": true, "excludeProtected": true, "excludeNotDocumented": true, + "cleanOutputDir": true, "excludeTags": ["@internalnote", "@internal"], "hideGenerator": true, "readme": "none", "gitRevision": "main", "disableSources": true, "hideBreadcrumbs": true, - "namedAnchors": true + "namedAnchors": true, + "hidePageTitle": true, + "publicPath": "./" }