@ygracs/xepg-lib-js 0.0.26-b → 0.0.30

package/lib/xepg-sched.d.ts

@@ -0,0 +1,231 @@
+/**
+ * A schedule info descriptor
+ */
+export type IXEpgShedInfoDesc = {
+    /**
+     * - a schedule start time
+     */
+    time: number;
+    /**
+     * - schedule title
+     */
+    title: string;
+    /**
+     * - schedule category
+     */
+    cat?: string;
+    /**
+     * - schedule rating
+     */
+    pcmark?: number;
+    /**
+     * - schedule description
+     */
+    descr?: string;
+};
+export const IXEpgShedInfoDesc: IXEpgShedInfoDesc;
+/**
+ * An XEPG-element options set (base)
+ */
+export type OPT_epgelsett_bs = {
+    /**
+     * - parser options
+     */
+    parseOptions?: InstanceType<typeof TXmlContentParseOptions>;
+};
+/**
+ * An XEPG-element options set (base)
+ */
+export type XEpgElementConfigBase = {
+    /**
+     * - parser options
+     */
+    parseOptions: InstanceType<typeof TXmlContentParseOptions>;
+};
+/**
+ * An extra options set
+ */
+export type OPT_extra = {
+    /**
+     * - 'DTS'-settings
+     */
+    dts_src?: object;
+    /**
+     * - 'TZ'-settings
+     */
+    tz_src?: object;
+};
+/**
+ * An XEPG-element options set (extend)
+ */
+export type OPT_epgelsett_ex = {
+    /**
+     * - parser options
+     */
+    parseOptions?: InstanceType<typeof TXmlContentParseOptions>;
+    dts_src?: object;
+    tz_src?: object;
+};
+
+/**
+ * This class implements an interface of a EPG-schedule element
+ * @since 0.0.22
+ */
+export class TXEpgScheduleItem {
+    /**
+     * Creates an instance of the EPG-schedule element
+     */
+    constructor(obj: INode, opt?: OPT_epgelsett_ex, extra?: OPT_extra);
+    /**
+     * Contains a dtstype ID
+     */
+    get dtstype(): number;
+    /**
+     * Contains a TZ-offset
+     */
+    get curDocTZ(): number;
+    /**
+     * Contains a schedule start time as a timestamp
+     */
+    get time(): number;
+    /**
+     * Contains a schedule title
+     */
+    get title(): string;
+    /**
+     * Contains a schedule category
+     */
+    get category(): string;
+    /**
+     * Contains a schedule rating value (aka pcmark)
+     */
+    get rating(): number;
+    /**
+     * Contains a schedule description
+     */
+    get descr(): string;
+    /**
+     * Returns a schedule info item descriptor
+     */
+    getInfo(): IXEpgShedInfoDesc;
+    /**
+     * Sets a schedule start time.
+     */
+    setTime(value: number | string | Date): boolean;
+    /**
+     * Sets a schedule title.
+     */
+    setTitle(value: string): boolean;
+    /**
+     * Sets a schedule title.
+     */
+    setCategory(value: string): boolean;
+    /**
+     * Sets a schedule rating value.
+     */
+    setRating(value: number | string): boolean;
+    /**
+     * Sets a schedule description.
+     */
+    setDescr(value: string): boolean;
+    /**
+     * Returns an instance content as a string in an XML-format.
+     */
+    saveToXMLString(): string;
+    /**
+     * Loads an element content from a string.
+     * @since v0.0.24
+     * @throws {Error}
+     * @experimental
+     */
+    loadFromXMLString(xmlString: string): boolean;
+    #private;
+}
+
+/**
+ * This class implements an interface of a EPG-schedules list
+ */
+export class TXEpgSchedulesList {
+    /**
+     * Creates an instance of the schedules list
+     */
+    constructor(obj: INode[], opt?: OPT_epgelsett_ex, extra?: OPT_extra);
+    /**
+     * Contains a quantity of a schedules
+     * @deprecated
+     * @todo \[since `v0.0.24`] deprecated. Use `TXEpgSchedulesList.count`
+     */
+    get schedQty(): number;
+    /**
+     * Contains a quantity of a schedules
+     * @since v0.0.24
+     */
+    get count(): number;
+    /**
+     * Contains a dtstype ID
+     */
+    get dtstype(): number;
+    /**
+     * Contains a TZ-offset
+     */
+    get curDocTZ(): number;
+    /**
+     * Indicates whether an instance has none member
+     * @since v0.0.24
+     */
+    isEmpty(): boolean;
+    /**
+     * Indicates whether an instance has any member
+     * @since v0.0.24
+     */
+    isNotEmpty(): boolean;
+    /**
+     * Checks whether a given value is a valid index and it fits the index range
+     * of an instance
+     * @since 0.0.20
+     * @deprecated
+     * @todo \[since v0.0.30] deprecated. Use {@link checkIndex} instead
+     */
+    chkIndex(value: number | string): boolean;
+    /**
+     * Checks whether a given value is a valid index and it fits the index range
+     * of an instance
+     * @since 0.0.30
+     */
+    checkIndex(value: number | string): boolean;
+    /**
+     * Returns a schedule element addressed by a given index
+     * @since 0.0.22
+     */
+    schedule(index: number | string): TXEpgScheduleItem | null;
+    /**
+     * Returns a schedule info item for instance element addressed
+     * by a given index
+     */
+    getScheduleInfo(index: number | string): IXEpgShedInfoDesc | null;
+    /**
+     * Returns a schedule info for instance members
+     */
+    getAllSchedulesInfo(): IXEpgShedInfoDesc[];
+    /**
+     * @protected
+     */
+    protected asJSON(): string;
+    [Symbol.iterator](): {
+        next: () => {
+            done: boolean;
+            value: TXEpgScheduleItem | null;
+        } | {
+            done: boolean;
+            value: undefined;
+        };
+        return(): {
+            done: boolean;
+            value: undefined;
+        };
+    };
+    #private;
+}
+
+import { TXmlContentParseOptions } from "@ygracs/xobj-lib-js";
+import type { INode } from "@ygracs/xobj-lib-js";