fix js-doc

This commit is contained in:
Timo K
2026-01-05 22:20:19 +01:00
parent 69a4189517
commit 556a87d141
6 changed files with 27 additions and 20 deletions

View File

@@ -31,8 +31,8 @@ export interface ConnectionFactory {
createConnection(
transport: LivekitTransport,
scope: ObservableScope,
logger: Logger,
ownMembershipIdentity: CallMembershipIdentityParts,
logger: Logger,
forceOldJwtEndpoint?: boolean,
): Connection;
}
@@ -83,17 +83,18 @@ export class ECConnectionFactory implements ConnectionFactory {
/**
*
* @param transport
* @param scope
* @param logger
* @param transport The transport to use for this connection.
* @param scope The observable scope (used for clean-up)
* @param ownMembershipIdentity required to connect (using the jwt service) with the SFU.
* @param logger The logger instance to use for this connection.
* @param forceOldJwtEndpoint Use the old JWT endpoint independent of what the sfu supports.
* @returns
*/
public createConnection(
transport: LivekitTransport,
scope: ObservableScope,
logger: Logger,
ownMembershipIdentity: CallMembershipIdentityParts,
logger: Logger,
forceOldJwtEndpoint?: boolean,
): Connection {
return new Connection(

View File

@@ -83,8 +83,12 @@ export interface IConnectionManager {
* @param props - Configuration object
* @param props.scope - The observable scope used by this object
* @param props.connectionFactory - Used to create new connections
* @param props.inputTransports$ - A list of Behaviors each containing a LIST of LivekitTransport.
* @param props.logger - The logger to use
* @param props.localTransport$ - The local transport to use. (deduplicated with remoteTransports$)
* @param props.remoteTransports$ - All other transports. The connection manager will create connections for each transport. (deduplicated with localTransport$)
* @param props.ownMembershipIdentity - The own membership identity to use.
* @param props.logger - The logger to use.
* @param props.forceOldJwtEndpointForLocalTransport$ - Use the old JWT endpoint independent of what the sfu supports. Only applies for localTransport$.
*
* Each of these behaviors can be interpreted as subscribed list of transports.
*
* Using `registerTransports` independent external modules can control what connections
@@ -183,8 +187,8 @@ export function createConnectionManager$({
livekit_alias: alias,
},
scope,
logger,
ownMembershipIdentity,
logger,
forceOldJwtEndpoint,
);
// Start the connection immediately

View File

@@ -79,8 +79,8 @@ describe("ECConnectionFactory - Audio inputs options", () => {
ecConnectionFactory.createConnection(
exampleTransport,
testScope,
logger,
ownMemberMock,
logger,
);
// Check if Room was constructed with expected options
@@ -125,8 +125,8 @@ describe("ECConnectionFactory - ControlledAudioDevice", () => {
ecConnectionFactory.createConnection(
exampleTransport,
testScope,
logger,
ownMemberMock,
logger,
);
// Check if Room was constructed with expected options