@ctrl/nzbget
    Preparing search index...

    Interface UsenetClient

    interface UsenetClient {
        config: UsenetClientConfig;
        state: UsenetClientState;
        addNzbFile(
            nzb: string | Uint8Array<ArrayBufferLike>,
            options?: Partial<AddNzbOptions>,
        ): Promise<string>;
        addNzbUrl(url: string, options?: Partial<AddNzbOptions>): Promise<string>;
        exportState(): UsenetClientState;
        findJob(id: string): Promise<FoundUsenetJob | null>;
        getAllData(): Promise<AllClientData>;
        getHistory(): Promise<NormalizedUsenetHistoryItem[]>;
        getHistoryJob(id: string): Promise<NormalizedUsenetHistoryItem>;
        getQueue(): Promise<NormalizedUsenetJob[]>;
        getQueueJob(id: string): Promise<NormalizedUsenetJob>;
        moveJob(id: string, position: number): Promise<boolean>;
        normalizedAddNzb(
            input: NzbInput,
            options?: Partial<AddNzbOptions>,
        ): Promise<NormalizedUsenetJob>;
        pauseJob(id: string): Promise<boolean>;
        pauseQueue(): Promise<boolean>;
        removeJob(id: string, removeData?: boolean): Promise<boolean>;
        resumeJob(id: string): Promise<boolean>;
        resumeQueue(): Promise<boolean>;
        setCategory(id: string, category: string): Promise<boolean>;
        setPriority(id: string, priority: UsenetPriority): Promise<boolean>;
    }

    Implemented by

    Index
    config state
    addNzbFile addNzbUrl exportState findJob getAllData getHistory getHistoryJob getQueue getQueueJob moveJob normalizedAddNzb pauseJob pauseQueue removeJob resumeJob resumeQueue setCategory setPriority
    config: UsenetClientConfig
    state: UsenetClientState

    • Parameters

      • nzb: string | Uint8Array<ArrayBufferLike>
      • Optionaloptions: Partial<AddNzbOptions>

      Returns Promise<string>

    • Parameters

      Returns Promise<string>

    • Export the current state of the client. Can be restored with createFromState.

      Returns UsenetClientState

    • Parameters

      • id: string

      Returns Promise<FoundUsenetJob | null>

    • Returns queue, history, categories, scripts, and status in normalized form.

      Returns Promise<AllClientData>

    • Returns Promise<NormalizedUsenetJob[]>

    • Parameters

      • id: string

      Returns Promise<NormalizedUsenetJob>

    • Parameters

      • id: string
      • position: number

      Returns Promise<boolean>

    • Parameters

      • id: string

      Returns Promise<boolean>

    • Returns Promise<boolean>

    • Parameters

      • id: string
      • OptionalremoveData: boolean

      Returns Promise<boolean>

    • Parameters

      • id: string

      Returns Promise<boolean>

    • Returns Promise<boolean>

    • Parameters

      • id: string
      • category: string

      Returns Promise<boolean>

    • Parameters

      Returns Promise<boolean>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods