Class Nzbget

constructor

• new Nzbget(options?: Partial<UsenetClientConfig>): Nzbget

  Parameters

  • options: Partial<UsenetClientConfig> = {}

  Returns Nzbget

config

state

addNzbFile

• addNzbFile(
      nzb: string | Uint8Array<ArrayBufferLike>,
      options?: Partial<AddNzbOptions>,
  ): Promise<string>

  Parameters

  • nzb: string | Uint8Array<ArrayBufferLike>
  • options: Partial<AddNzbOptions> = {}

  Returns Promise<string>

addNzbUrl

• addNzbUrl(url: string, options?: Partial<AddNzbOptions>): Promise<string>

  Parameters

  • url: string
  • options: Partial<AddNzbOptions> = {}

  Returns Promise<string>

append

• append(
      name: string,
      contentOrUrl: string,
      options?: NzbGetAddOptions,
  ): Promise<number>

  Calls append.

  NZBGet reads JSON-RPC params as a flat stream of values, so ppParameters are sent as [name, value, ...]. Sending {Name, Value} objects would store Name=drone and Value=<id> as two separate parameters.

  Parameters

  • name: string
  • contentOrUrl: string
  • options: NzbGetAddOptions = {}

  Returns Promise<number>

  Link

  https://github.com/nzbgetcom/nzbget/blob/develop/daemon/remote/XmlRpc.cpp (DownloadXmlCommand::Execute)

clearLog

• clearLog(): Promise<boolean>

  Calls clearlog, which empties the in-memory log returned by Nzbget.log.

  Returns Promise<boolean>

  Link

  https://github.com/nzbgetcom/nzbget/blob/develop/daemon/remote/XmlRpc.cpp

configTemplates

• configTemplates(loadFromDisk?: boolean): Promise<NzbGetConfigTemplate[]>

  Calls configtemplates.

  Parameters

  • loadFromDisk: boolean = false

  Returns Promise<NzbGetConfigTemplate[]>

editQueue

• editQueue<TCommand extends NzbGetEditQueueCommand>(
      command: TCommand,
      parameter: NzbGetEditQueueParameter<TCommand>,
      ids: string | number | (string | number)[],
  ): Promise<boolean>

  Calls editqueue with the v18+ signature.

  Type Parameters

  • TCommand extends NzbGetEditQueueCommand

  Parameters

  • command: TCommand
  • parameter: NzbGetEditQueueParameter<TCommand>
  • ids: string | number | (string | number)[]

  Returns Promise<boolean>

exportState

• exportState(): Jsonify<NzbgetState>

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

  Returns Jsonify<NzbgetState>

findJob

• findJob(id: string): Promise<FoundUsenetJob | null>

  Parameters

  • id: string

  Returns Promise<FoundUsenetJob | null>

getAllData

• getAllData(): Promise<AllClientData>

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

  Returns Promise<AllClientData>

getCategories

• getCategories(): Promise<Category[]>

  Returns Promise<Category[]>

getConfig

• getConfig(): Promise<NzbGetSettings>

  Calls config.

  Returns Promise<NzbGetSettings>

getHistory

• getHistory(): Promise<NormalizedUsenetHistoryItem[]>

  Returns Promise<NormalizedUsenetHistoryItem[]>

getHistoryJob

• getHistoryJob(id: string): Promise<NormalizedUsenetHistoryItem>

  Parameters

  • id: string

  Returns Promise<NormalizedUsenetHistoryItem>

getQueue

• getQueue(): Promise<NormalizedUsenetJob[]>

  Returns Promise<NormalizedUsenetJob[]>

getQueueJob

• getQueueJob(id: string): Promise<NormalizedUsenetJob>

  Parameters

  • id: string

  Returns Promise<NormalizedUsenetJob>

getScripts

• getScripts(): Promise<Script[]>

  Returns Promise<Script[]>

getVersion

• getVersion(): Promise<string>

  Calls version.

  Returns Promise<string>

history

• history(hidden?: boolean): Promise<NzbGetHistoryItem[]>

  Calls history.

  Parameters

  • hidden: boolean = false

  Returns Promise<NzbGetHistoryItem[]>

listFiles

• listFiles(id: string | number): Promise<NzbGetFile[]>

  Calls listfiles.

  Parameters

  • id: string | number

  Returns Promise<NzbGetFile[]>

listGroups

• listGroups(): Promise<NzbGetQueueItem[]>

  Calls listgroups.

  Returns Promise<NzbGetQueueItem[]>

loadConfig

• loadConfig(): Promise<NzbGetConfigItem[]>

  Calls loadconfig. Values are returned as stored in the file, e.g. ${MainDir}/dst.

  Returns Promise<NzbGetConfigItem[]>

loadLog

• loadLog(
      nzbId: string | number,
      idFrom: number,
      numberOfEntries: number,
  ): Promise<NzbGetLogEntry[]>

  Calls loadlog.

  Parameters

  • nzbId: string | number
  • idFrom: number
  • numberOfEntries: number

  Returns Promise<NzbGetLogEntry[]>

log

• log(idFrom: number, numberOfEntries: number): Promise<NzbGetLogEntry[]>

  Calls log.

  Parameters

  • idFrom: number
  • numberOfEntries: number

  Returns Promise<NzbGetLogEntry[]>

moveJob

• moveJob(id: string, position: number): Promise<boolean>

  Parameters

  • id: string
  • position: number

  Returns Promise<boolean>

normalizedAddNzb

• normalizedAddNzb(
      input: NzbInput,
      options?: Partial<AddNzbOptions>,
  ): Promise<NormalizedUsenetJob>

  Parameters

  • input: NzbInput
  • options: Partial<AddNzbOptions> = {}

  Returns Promise<NormalizedUsenetJob>

pauseDownload

• pauseDownload(): Promise<boolean>

  Calls pausedownload.

  Returns Promise<boolean>

pauseJob

• pauseJob(id: string): Promise<boolean>

  Parameters

  • id: string

  Returns Promise<boolean>

pausePost

• pausePost(): Promise<boolean>

  Calls pausepost.

  Returns Promise<boolean>

pauseQueue

• pauseQueue(): Promise<boolean>

  Returns Promise<boolean>

pauseScan

• pauseScan(): Promise<boolean>

  Calls pausescan.

  Returns Promise<boolean>

reload

• reload(): Promise<boolean>

  Calls reload.

  Returns Promise<boolean>

removeJob

• removeJob(id: string, removeData?: boolean): Promise<boolean>

  Deletes a queue job (GroupDelete, or GroupFinalDelete to skip history), or a history item (HistoryDelete keeps a hidden record for duplicate checks, HistoryFinalDelete removes it entirely).

  Parameters

  • id: string
  • removeData: boolean = false

  Returns Promise<boolean>

resetServerVolume

• resetServerVolume(
      serverId: number,
      counter?: NzbGetServerVolumeCounter,
  ): Promise<boolean>

  Calls resetservervolume.

  Parameters

  • serverId: number

    ServerID from Nzbget.serverVolumes, or -1 for all servers.

  • counter: NzbGetServerVolumeCounter = ''

  Returns Promise<boolean>

resumeDownload

• resumeDownload(): Promise<boolean>

  Calls resumedownload.

  Returns Promise<boolean>

resumeJob

• resumeJob(id: string): Promise<boolean>

  Parameters

  • id: string

  Returns Promise<boolean>

resumePost

• resumePost(): Promise<boolean>

  Calls resumepost.

  Returns Promise<boolean>

resumeQueue

• resumeQueue(): Promise<boolean>

  Returns Promise<boolean>

resumeScan

• resumeScan(): Promise<boolean>

  Calls resumescan.

  Returns Promise<boolean>

saveConfig

• saveConfig(items: NzbGetConfigItem[]): Promise<boolean>

  Calls saveconfig.

  Rewrites the config file with exactly these options; any option left out is removed from the file. Start from Nzbget.loadConfig and call Nzbget.reload to apply.

  Parameters

  • items: NzbGetConfigItem[]

  Returns Promise<boolean>

scan

• scan(): Promise<boolean>

  Calls scan.

  Returns Promise<boolean>

scheduleResume

• scheduleResume(seconds: number): Promise<boolean>

  Calls scheduleresume.

  Parameters

  • seconds: number

  Returns Promise<boolean>

serverVolumes

• serverVolumes(): Promise<NzbGetServerVolume[]>

  Calls servervolumes.

  Returns Promise<NzbGetServerVolume[]>

setCategory

• setCategory(id: string, category: string): Promise<boolean>

  Parameters

  • id: string
  • category: string

  Returns Promise<boolean>

setPriority

• setPriority(id: string, priority: UsenetPriority): Promise<boolean>

  Parameters

  • id: string
  • priority: UsenetPriority

  Returns Promise<boolean>

setRate

• setRate(limitBytesPerSecond: number): Promise<boolean>

  Calls rate.

  Parameters

  • limitBytesPerSecond: number

  Returns Promise<boolean>

shutdown

• shutdown(): Promise<boolean>

  Calls shutdown.

  Returns Promise<boolean>

status

• status(): Promise<NzbGetStatus>

  Calls status.

  Returns Promise<NzbGetStatus>

sysInfo

• sysInfo(): Promise<NzbGetSysInfo>

  Calls sysinfo (v24.2+).

  Returns Promise<NzbGetSysInfo>

systemHealth

• systemHealth(): Promise<NzbGetSystemHealth>

  Calls systemhealth (v26.0+). Marked experimental upstream.

  Returns Promise<NzbGetSystemHealth>

writeLog

• writeLog(kind: NzbGetLogKind, text: string): Promise<boolean>

  Calls writelog.

  Parameters

  • kind: NzbGetLogKind
  • text: string

  Returns Promise<boolean>

StaticcreateFromState

• createFromState(
      config: Readonly<UsenetClientConfig>,
      state: Readonly<Jsonify<NzbgetState>>,
  ): Nzbget

  Parameters

  • config: Readonly<UsenetClientConfig>
  • state: Readonly<Jsonify<NzbgetState>>

  Returns Nzbget