From cb0145d58f0d0601e2156187e265bb485dc45e14 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Fri, 29 Dec 2023 17:51:21 +0100 Subject: [PATCH] Capitalization --- .docs/content/2.essentials/4.using-streams.md | 8 ++++---- .docs/content/4.extra-topics/0.development.md | 2 +- .docs/content/5.api-reference/0.makeProviders.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.docs/content/2.essentials/4.using-streams.md b/.docs/content/2.essentials/4.using-streams.md index 5812fe3..64ec16f 100644 --- a/.docs/content/2.essentials/4.using-streams.md +++ b/.docs/content/2.essentials/4.using-streams.md @@ -75,10 +75,10 @@ If your target is set to `BROWSER`. There will never be required headers, as it' All streams have a list of captions at `Stream.captions`. The structure looks like this: ```ts type Caption = { - type: CaptionType; // language type, either "srt" or "vtt" - id: string; // only unique per stream - url: string; // the url pointing to the subtitle file + type: CaptionType; // Language type, either "srt" or "vtt" + id: string; // Unique per stream + url: string; // The url pointing to the subtitle file hasCorsRestrictions: boolean; // If true, you will need to proxy it if you're running in a browser - language: string; // language code of the caption + language: string; // Language code of the caption }; ``` diff --git a/.docs/content/4.extra-topics/0.development.md b/.docs/content/4.extra-topics/0.development.md index fef430e..8bf65a0 100644 --- a/.docs/content/4.extra-topics/0.development.md +++ b/.docs/content/4.extra-topics/0.development.md @@ -64,7 +64,7 @@ npm run cli -- -sid febbox-mp4 -u URL_HERE The CLI comes with a few built-in fetchers: - `node-fetch`: Fetch using the "node-fetch" library. - - `native`: Use the new fetch built into nodejs (undici). + - `native`: Use the new fetch built into Node.JS (undici). - `browser`: Start up headless chrome, and run the library in that context using a proxied fetcher. ::alert{type="warning"} diff --git a/.docs/content/5.api-reference/0.makeProviders.md b/.docs/content/5.api-reference/0.makeProviders.md index 3811c90..c76794a 100644 --- a/.docs/content/5.api-reference/0.makeProviders.md +++ b/.docs/content/5.api-reference/0.makeProviders.md @@ -25,7 +25,7 @@ interface ProviderBuilderOptions { // instance of a fetcher, in case the request has cors restrictions. // this fetcher will be called instead of normal fetcher. - // if your environment doesnt have cors restrictions (like nodejs), there is no need to set this. + // if your environment doesnt have cors restrictions (like Node.JS), there is no need to set this. proxiedFetcher?: Fetcher; // target to get streams for