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.

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

Fix API docs problems #283

Merged
merged 4 commits into from
Oct 11, 2023
Merged

Fix API docs problems #283

merged 4 commits into from
Oct 11, 2023

Conversation

rolandkakonyi
Copy link
Contributor

@rolandkakonyi rolandkakonyi commented Oct 10, 2023

Description

There are warnings when generating docs using yarn docs.

Changes

  1. Turned on "treatWarningsAsErrors" to enforce writing documentation
  2. Fixed SideLoadedSubtitleTrack API to provide without MakeRequired hack
  3. Fixed various warnings

Checklist

  • 🗒 CHANGELOG entry - not applicable

@rolandkakonyi rolandkakonyi self-assigned this Oct 10, 2023
Comment on lines +42 to +70
const handleBitmovinNativeOfflineEvent = (
data: BitmovinNativeOfflineEventData,
listeners: Set<OfflineContentManagerListener>
) => {
listeners.forEach((listener) => {
if (!listener) return;

if (data.eventType === OfflineEventType.onCompleted) {
listener.onCompleted?.(data);
} else if (data.eventType === OfflineEventType.onError) {
listener.onError?.(data);
} else if (data.eventType === OfflineEventType.onProgress) {
listener.onProgress?.(data);
} else if (data.eventType === OfflineEventType.onOptionsAvailable) {
listener.onOptionsAvailable?.(data);
} else if (data.eventType === OfflineEventType.onDrmLicenseUpdated) {
listener.onDrmLicenseUpdated?.(data);
} else if (data.eventType === OfflineEventType.onDrmLicenseExpired) {
listener.onDrmLicenseExpired?.(data);
} else if (data.eventType === OfflineEventType.onSuspended) {
listener.onSuspended?.(data);
} else if (data.eventType === OfflineEventType.onResumed) {
listener.onResumed?.(data);
} else if (data.eventType === OfflineEventType.onCanceled) {
listener.onCanceled?.(data);
}
});
};

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was just moved to avoid exporting it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got rid of MakeRequired as we don't need it at all.

src/utils.ts Outdated
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got rid of MakeRequired as we don't need it at all.

@rolandkakonyi rolandkakonyi marked this pull request as ready for review October 10, 2023 09:30
Copy link
Contributor

@zigavehovec zigavehovec left a comment

Choose a reason for hiding this comment

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

Nice improvements 👍
I added one suggestion, let me know what you think about it 🙂

src/subtitleTrack.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@zigavehovec zigavehovec left a comment

Choose a reason for hiding this comment

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

Nice 👍

Base automatically changed from add-api-docs-generation-command to development October 11, 2023 09:35
@rolandkakonyi rolandkakonyi merged commit 80a0b72 into development Oct 11, 2023
5 checks passed
@rolandkakonyi rolandkakonyi deleted the fix-api-docs-problems branch October 11, 2023 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants