Add typescript support

Author: codeit-ninja

dist/main.d.ts

@@ -0,0 +1,7 @@
+import { hmsToSeconds } from "./src/helpers.js";
+import { toVttCue } from "./src/helpers.js";
+import { transformSrtTracks } from "./src/transformer.js";
+import { srt2vtt } from "./src/helpers.js";
+import { fetchTrack } from "./src/helpers.js";
+export { hmsToSeconds, toVttCue, transformSrtTracks, srt2vtt, fetchTrack };
+//# sourceMappingURL=main.d.ts.map

dist/main.d.ts.map

@@ -0,0 +1,47 @@
+/**
+ * A valid VTT cue
+ *
+ * The properties of this class are compatible with `VTTCue`
+ * and can be used to create a `new VTTCue` instance
+ *
+ * *Example*
+ * ```js
+ * new VTTCue(cue.startTime, cue.endTime, cue.text);
+ * ```
+ *
+ * @property {number}   number
+ * @property {number}   startTime
+ * @property {number}   endTime
+ * @property {string}   text
+ */
+export default class Cue {
+    /**
+     *
+     * @param {number} number
+     * @param {number} startTime
+     * @param {number} endTime
+     * @param {string} text
+     */
+    constructor(number: number, startTime: number, endTime: number, text: string);
+    /**
+     * @readonly
+     * @type {number}
+     */
+    readonly number: number;
+    /**
+     * @readonly
+     * @type {number}
+     */
+    readonly startTime: number;
+    /**
+     * @readonly
+     * @type {number}
+     */
+    readonly endTime: number;
+    /**
+     * @readonly
+     * @type {string}
+     */
+    readonly text: string;
+}
+//# sourceMappingURL=cue.d.ts.map

dist/src/cue.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Converts an SRT cue into a VTT compatible cue
+ *
+ * For example
+ *
+ * ```txt
+ * 1
+ * 00:00:00,498 --> 00:00:02,827
+ * Here's what I love most
+ * about food and diet.
+ * ```
+ *
+ * Will be converted into
+ *
+ * ```js
+ * Cue {
+ *     number: 1,
+ *     startTime: 0.498
+ *     endTime: 2.827,
+ *     text: 'Here\'s what I love most\n about food and diet.'
+ * }
+ * ```
+ *
+ * @param {string} srtCue
+ * @returns Cue
+ */
+export function toVttCue(srtCue: string): Cue;
+/**
+ * Converts a VTT or SRT timing `string`
+ * to a `number` in seconds + milliseconds
+ *
+ * *Example*
+ * ```js
+ * const seconds = hmsToSeconds('00:00:02.827'); // 2.827
+ * ```
+ *
+ * @param {string} str
+ * @returns number
+ */
+export function hmsToSeconds(str: string): number;
+/**
+ * Fetches the contents of a track source
+ *
+ * *Example*
+ * ```js
+ * const content = await fetchTrack('https://example.com/path/my-subtitle.srt')
+ * ```
+ * @param {string} src          - url
+ * @param {string} encoding     - file encoding format
+ * @returns Promise<string>
+ */
+export function fetchTrack(src: string, encoding?: string): Promise<string>;
+/**
+ * Converts SRT formatted string into a WebVTT formated string
+ *
+ * *Example*
+ *
+ * Converts
+ * ```text
+ * 1
+ * 00:00:00,498 --> 00:00:02,827
+ * - Here's what I love most
+ * about food and diet.
+ *
+ * 2
+ * 00:00:02,827 --> 00:00:06,383
+ * We all eat several times a day,
+ * and we're totally in charge
+ * ```
+ *
+ * Into
+ * ```text
+ * WEBVTT
+ *
+ * 1
+ * 00:00:00.498 --> 00:00:02.827
+ * - Here's what I love most
+ * about food and diet.
+ *
+ * 2
+ * 00:00:02.827 --> 00:00:06.383
+ * We all eat several times a day,
+ * and we're totally in charge
+ * ```
+ *
+ * @param {string} srtBody
+ * @returns string
+ */
+export function srt2vtt(srtBody: string): string;
+import Cue from "./cue.js";
+//# sourceMappingURL=helpers.d.ts.map

dist/src/cue.d.ts.map

@@ -0,0 +1,67 @@
+/**
+ * @property {string}   src
+ * @property {string}   encoding
+ * @property {string}   lang
+ * @property {string}   kind
+ * @property {string}   label
+ * @property {string}   default
+ * @property {string}   body
+ * @property {boolean}     needsTransform
+ * @property {Cue[]}    cues
+ */
+export default class Track {
+    /**
+     * Parses a `HTMLTrackElement`
+     *
+     * @param {HTMLTrackElement} track
+     */
+    constructor(track: HTMLTrackElement);
+    /**
+     * @readonly
+     * @type {string}
+     */
+    readonly src: string;
+    /**
+     * @readonly
+     * @type {string}
+     */
+    readonly encoding: string;
+    /**
+     * @readonly
+     * @type {string}
+     */
+    readonly lang: string;
+    /**
+     * @readonly
+     * @type {string}
+     */
+    readonly kind: string;
+    /**
+     * @readonly
+     * @type {string}
+     */
+    readonly label: string;
+    /**
+     * @readonly
+     * @type {boolean}
+     */
+    readonly default: boolean;
+    /**
+     * @readonly
+     * @type {string}
+     */
+    readonly body: string;
+    /**
+     * @readonly
+     * @type {boolean}
+     */
+    readonly needsTransform: boolean;
+    /**
+     * @readonly
+     * @type {Cue[]}
+     */
+    readonly cues: Cue[];
+    parse(): Promise<void>;
+}
+import Cue from "./cue.js";
+//# sourceMappingURL=track.d.ts.map

dist/src/helpers.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts all SRT files into WebVTT files.
+ *
+ * @param {HTMLVideoElement} video
+ */
+export function transformSrtTracks(video: HTMLVideoElement): Promise<void>;
+//# sourceMappingURL=transformer.d.ts.map