Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix ingress creation parameter inline documentation #296

Merged
merged 8 commits into from
Oct 11, 2024
Merged

Fix ingress creation parameter inline documentation #296

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6d72a96
Fix ingress creation parameter inline documentation
biglittlebigben Oct 11, 2024
6e79d67
Create mean-stingrays-occur.md
biglittlebigben Oct 11, 2024
c910313
fmt
biglittlebigben Oct 11, 2024
e293ec5
Merge remote-tracking branch 'origin/benjamin/inline_docs' into benja…
biglittlebigben Oct 11, 2024
8622d73
WiP
biglittlebigben Oct 11, 2024
2fb35a6
Better enforcement of parameters
biglittlebigben Oct 11, 2024
b42ce93
WiP
biglittlebigben Oct 11, 2024
681011e
Update packages/livekit-server-sdk/src/IngressClient.ts
biglittlebigben Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/mean-stingrays-occur.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"livekit-server-sdk": patch
---

Fix ingress creation parameter inline documentation
16 changes: 8 additions & 8 deletions packages/livekit-server-sdk/src/IngressClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ export interface CreateIngressOptions {
*/
name?: string;
/**
* name of the room to send media to. optional
* name of the room to send media to.
*/
roomName?: string;
roomName: string;
/**
* unique identity of the participant. optional
* unique identity of the participant.
*/
participantIdentity?: string;
participantIdentity: string;
/**
* participant display name
*/
Expand Down Expand Up @@ -67,11 +67,11 @@ export interface UpdateIngressOptions {
*/
name: string;
/**
* name of the room to send media to. optional
* name of the room to send media to.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is optional right? on updates.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything is optional in the dictionary in the sense that parameters left out will not be updated. It's odd to single out these 2 parameters. We could flag all parameters as optional, but this seems redundant on a parameter called "UpdateIngressOptions".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

got it.. makes sense.

*/
roomName?: string;
/**
* unique identity of the participant. optional
* unique identity of the participant.
*/
participantIdentity?: string;
/**
Expand Down Expand Up @@ -148,9 +148,9 @@ export class IngressClient extends ServiceBase {

if (opts !== undefined) {
name = opts.name || '';
roomName = opts.roomName || '';
roomName = opts.roomName;
participantName = opts.participantName || '';
participantIdentity = opts.participantIdentity || '';
participantIdentity = opts.participantIdentity;
bypassTranscoding = opts.bypassTranscoding || false;
enableTranscoding = opts.enableTranscoding;
url = opts.url || '';
Expand Down