Class IaCatalog`Beta`

This class represents the Archive.org catalog. You can use this class to access and submit tasks from the catalog.

This is a low-level interface, and in most cases the functions in the internetarchive-ts module and methods in IaSession should be used.

It uses the archive.org Tasks API

Example

import { getSession, IaCatalog } from "internetarchive-ts";
const s = getSession();
const c = new Catalog(s);
let tasks = c.getTasks('nasa');

Index

Constructors

constructor

new IaCatalog(session: IaSession): IaCatalog
Beta
Initialize IaCatalog
Parameters
- session: IaSession
  An IaSession object
Returns IaCatalog
- Defined in src/catalog/IaCatalog.ts:67

Properties

`Readonly` `Beta`session

session: IaSession

An IaSession object

`Protected` `Readonly` `Beta`url

url: string

Methods

getRateLimit

getRateLimit<
    T extends
        | "book_op.php"
        | "bup.php"
        | "delete.php"
        | "derive.php"
        | "fixer.php"
        | "make_dark.php"
        | "make_undark.php"
        | "rename.php",
>(
    cmd?:
        | "book_op.php"
        | "bup.php"
        | "delete.php"
        | "derive.php"
        | "fixer.php"
        | "make_dark.php"
        | "make_undark.php"
        | "rename.php",
): Promise<
    {
        cmd: T;
        tasks_blocked_by_offline: number;
        tasks_inflight: number;
        tasks_limit: number;
    },
>
Beta
Returns rate limit for specified task type
Type Parameters
- T extends
      | "book_op.php"
      | "bup.php"
      | "delete.php"
      | "derive.php"
      | "fixer.php"
      | "make_dark.php"
      | "make_undark.php"
      | "rename.php"
Parameters
- cmd:
      | "book_op.php"
      | "bup.php"
      | "delete.php"
      | "derive.php"
      | "fixer.php"
      | "make_dark.php"
      | "make_undark.php"
      | "rename.php" = 'derive.php'
  Task type
Returns Promise<
    {
        cmd: T;
        tasks_blocked_by_offline: number;
        tasks_inflight: number;
        tasks_limit: number;
    },
>
Rate limit object

Throws
IaApiError

Throws
IaApiUnauthorizedError
- Defined in src/catalog/IaCatalog.ts:139

getSummary

getSummary(
    identifier: string,
    params?: {
        args?: string;
        cmd?: string;
        cursor?: string;
        limit?: number;
        priority?: number;
        server?: string;
        submitter?: string;
        "submittime<"?: string;
        "submittime<="?: string;
        "submittime>"?: string;
        "submittime>="?: string;
        task_id?: number;
        wait_admin?: number;
    },
): Promise<IaTaskSummary>
Beta
Get the total counts of catalog tasks meeting all criteria, organized by run status (queued, running, error, and paused). Important: If the supplied identifier does not exist, this method does not fail!
Parameters
- identifier: string
  Item identifier. Both '*' (asterisk) and '%' (percentage sign) may be used as wildcard characters within criteria that accept them.
- params: {
      args?: string;
      cmd?: string;
      cursor?: string;
      limit?: number;
      priority?: number;
      server?: string;
      submitter?: string;
      "submittime<"?: string;
      "submittime<="?: string;
      "submittime>"?: string;
      "submittime>="?: string;
      task_id?: number;
      wait_admin?: number;
  } = {}
  Query parameters
  - Optionalargs?: string
    Argument list (see below; may be wildcarded)
  - Optionalcmd?: string
    Task command (e.g., archive.php, modify_xml.php, etc.; may be wildcarded)
  - Optionalcursor?: string
    Cursor for pagination
  - Optionallimit?: number
    The current default is 50 tasks per request, but the caller may request more with the limit parameter The current maximum limit is 500 tasks. Values outside this range are clamped to the server maximum. If the caller wishes to receive all tasks in a single round-trip, they may set limit=0 in the request query.
    
    Default
    50
  - Optionalpriority?: number
    Generally from 10 to -10
  - Optionalserver?: string
    IA node task will or was executed upon (may be wildcarded)
  - Optionalsubmitter?: string
    User submitting task (may be wildcarded)
  - Optionalsubmittime<?: string
    Filter by submit time lower than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime<=?: string
    Filter by submit time lower or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>?: string
    Filter by submit time greater than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>=?: string
    Filter by submit time greater or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionaltask_id?: number
    Task identifier
  - Optionalwait_admin?: number
    Task run state (see below)
Returns Promise<IaTaskSummary>
the total counts of catalog tasks meeting all criteria

Throws
IaApiError
- Defined in src/catalog/IaCatalog.ts:102

getTasks

getTasks(
    params?: {
        args?: string;
        catalog?: 0 | 1;
        cmd?: string;
        cursor?: string;
        history?: 0 | 1;
        identifier?: string;
        priority?: number;
        server?: string;
        submitter?: string;
        "submittime<"?: string;
        "submittime<="?: string;
        "submittime>"?: string;
        "submittime>="?: string;
        task_id?: number;
        wait_admin?: number;
    },
): Promise<IaCatalogTask[]>
Beta
Get a list of all tasks meeting all criteria. The list is ordered by submission time.
Parameters
- params: {
      args?: string;
      catalog?: 0 | 1;
      cmd?: string;
      cursor?: string;
      history?: 0 | 1;
      identifier?: string;
      priority?: number;
      server?: string;
      submitter?: string;
      "submittime<"?: string;
      "submittime<="?: string;
      "submittime>"?: string;
      "submittime>="?: string;
      task_id?: number;
      wait_admin?: number;
  } = {}
  - Optionalargs?: string
    Argument list (see below; may be wildcarded)
  - Optionalcatalog?: 0 | 1
    A list of all active tasks (queued, running, error, or paused) matching the supplied criteria
  - Optionalcmd?: string
    Task command (e.g., archive.php, modify_xml.php, etc.; may be wildcarded)
  - Optionalcursor?: string
    Cursor for pagination
  - Optionalhistory?: 0 | 1
    A list of all completed tasks matching the supplied criteria
  - Optionalidentifier?: string
    The item identifier, if provided will return tasks for only this item filtered by other criteria provided in params.
  - Optionalpriority?: number
    Generally from 10 to -10
  - Optionalserver?: string
    IA node task will or was executed upon (may be wildcarded)
  - Optionalsubmitter?: string
    User submitting task (may be wildcarded)
  - Optionalsubmittime<?: string
    Filter by submit time lower than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime<=?: string
    Filter by submit time lower or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>?: string
    Filter by submit time greater than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>=?: string
    Filter by submit time greater or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionaltask_id?: number
    Task identifier
  - Optionalwait_admin?: number
    Task run state (see below)
Returns Promise<IaCatalogTask[]>
A list of all tasks meeting all criteria.
- Defined in src/catalog/IaCatalog.ts:165

iterTasks

iterTasks(
    params?: {
        args?: string;
        catalog?: 0 | 1;
        cmd?: string;
        cursor?: string;
        history?: 0 | 1;
        identifier?: string;
        limit?: number;
        priority?: number;
        server?: string;
        submitter?: string;
        "submittime<"?: string;
        "submittime<="?: string;
        "submittime>"?: string;
        "submittime>="?: string;
        summary?: 0 | 1;
        task_id?: number;
        wait_admin?: number;
    },
): AsyncGenerator<IaCatalogTask>
Beta
A generator that can make arbitrary requests to the Tasks API. It handles paging (via cursor) automatically.
Parameters
- params: {
      args?: string;
      catalog?: 0 | 1;
      cmd?: string;
      cursor?: string;
      history?: 0 | 1;
      identifier?: string;
      limit?: number;
      priority?: number;
      server?: string;
      submitter?: string;
      "submittime<"?: string;
      "submittime<="?: string;
      "submittime>"?: string;
      "submittime>="?: string;
      summary?: 0 | 1;
      task_id?: number;
      wait_admin?: number;
  } = {}
  Query parameters, refer to Tasks API for available parameters.
  - Optionalargs?: string
    Argument list (see below; may be wildcarded)
  - Optionalcatalog?: 0 | 1
    A list of all active tasks (queued, running, error, or paused) matching the supplied criteria
  - Optionalcmd?: string
    Task command (e.g., archive.php, modify_xml.php, etc.; may be wildcarded)
  - Optionalcursor?: string
    Cursor for pagination
  - Optionalhistory?: 0 | 1
    A list of all completed tasks matching the supplied criteria
  - Optionalidentifier?: string
    The item identifier, if provided will return tasks for only this item filtered by other criteria provided in params.
  - Optionallimit?: number
    The current default is 50 tasks per request, but the caller may request more with the limit parameter The current maximum limit is 500 tasks. Values outside this range are clamped to the server maximum. If the caller wishes to receive all tasks in a single round-trip, they may set limit=0 in the request query.
    
    Default
    50
  - Optionalpriority?: number
    Generally from 10 to -10
  - Optionalserver?: string
    IA node task will or was executed upon (may be wildcarded)
  - Optionalsubmitter?: string
    User submitting task (may be wildcarded)
  - Optionalsubmittime<?: string
    Filter by submit time lower than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime<=?: string
    Filter by submit time lower or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>?: string
    Filter by submit time greater than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>=?: string
    Filter by submit time greater or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsummary?: 0 | 1
    Total counts of catalog tasks meeting all criteria organized by run status (queued, running, error, and paused). Historical totals are currently unavailable.
    
    Default
    1
  - Optionaltask_id?: number
    Task identifier
  - Optionalwait_admin?: number
    Task run state (see below)
Returns AsyncGenerator<IaCatalogTask>
An AsyncGenerator that yields IaCatalogTask objects
- Defined in src/catalog/IaCatalog.ts:118

iterTasksNoLimit

iterTasksNoLimit(
    params?: {
        args?: string;
        catalog?: 0 | 1;
        cmd?: string;
        cursor?: string;
        history?: 0 | 1;
        identifier?: string;
        priority?: number;
        server?: string;
        submitter?: string;
        "submittime<"?: string;
        "submittime<="?: string;
        "submittime>"?: string;
        "submittime>="?: string;
        task_id?: number;
        wait_admin?: number;
    },
): AsyncGenerator<IaCatalogTask>
Beta
Create iterator that iterates over all catalog tasks
Parameters
- params: {
      args?: string;
      catalog?: 0 | 1;
      cmd?: string;
      cursor?: string;
      history?: 0 | 1;
      identifier?: string;
      priority?: number;
      server?: string;
      submitter?: string;
      "submittime<"?: string;
      "submittime<="?: string;
      "submittime>"?: string;
      "submittime>="?: string;
      task_id?: number;
      wait_admin?: number;
  } = {}
  Params
  - Optionalargs?: string
    Argument list (see below; may be wildcarded)
  - Optionalcatalog?: 0 | 1
    A list of all active tasks (queued, running, error, or paused) matching the supplied criteria
  - Optionalcmd?: string
    Task command (e.g., archive.php, modify_xml.php, etc.; may be wildcarded)
  - Optionalcursor?: string
    Cursor for pagination
  - Optionalhistory?: 0 | 1
    A list of all completed tasks matching the supplied criteria
  - Optionalidentifier?: string
    The item identifier, if provided will return tasks for only this item filtered by other criteria provided in params.
  - Optionalpriority?: number
    Generally from 10 to -10
  - Optionalserver?: string
    IA node task will or was executed upon (may be wildcarded)
  - Optionalsubmitter?: string
    User submitting task (may be wildcarded)
  - Optionalsubmittime<?: string
    Filter by submit time lower than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime<=?: string
    Filter by submit time lower or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>?: string
    Filter by submit time greater than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>=?: string
    Filter by submit time greater or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionaltask_id?: number
    Task identifier
  - Optionalwait_admin?: number
    Task run state (see below)
Returns AsyncGenerator<IaCatalogTask>
- Defined in src/catalog/IaCatalog.ts:173

`Protected`makeTasksRequest

makeTasksRequest<
    T extends
        | IaApiGetTasksResult
        | {
            cmd: | "book_op.php"
            | "bup.php"
            | "delete.php"
            | "derive.php"
            | "fixer.php"
            | "make_dark.php"
            | "make_undark.php"
            | "rename.php";
            tasks_blocked_by_offline: number;
            tasks_inflight: number;
            tasks_limit: number;
        },
>(
    params?: {
        args?: string;
        catalog?: 0 | 1;
        cmd?: string;
        cursor?: string;
        history?: 0 | 1;
        identifier?: string;
        limit?: number;
        priority?: number;
        server?: string;
        submitter?: string;
        "submittime<"?: string;
        "submittime<="?: string;
        "submittime>"?: string;
        "submittime>="?: string;
        summary?: 0 | 1;
        task_id?: number;
        wait_admin?: number;
    },
): Promise<T>
Beta
Make a GET request to the Tasks API
Type Parameters
- T extends
      | IaApiGetTasksResult
      | {
          cmd: | "book_op.php"
          | "bup.php"
          | "delete.php"
          | "derive.php"
          | "fixer.php"
          | "make_dark.php"
          | "make_undark.php"
          | "rename.php";
          tasks_blocked_by_offline: number;
          tasks_inflight: number;
          tasks_limit: number;
      }
Parameters
- params: {
      args?: string;
      catalog?: 0 | 1;
      cmd?: string;
      cursor?: string;
      history?: 0 | 1;
      identifier?: string;
      limit?: number;
      priority?: number;
      server?: string;
      submitter?: string;
      "submittime<"?: string;
      "submittime<="?: string;
      "submittime>"?: string;
      "submittime>="?: string;
      summary?: 0 | 1;
      task_id?: number;
      wait_admin?: number;
  } = {}
  Query parameters
  - Optionalargs?: string
    Argument list (see below; may be wildcarded)
  - Optionalcatalog?: 0 | 1
    A list of all active tasks (queued, running, error, or paused) matching the supplied criteria
  - Optionalcmd?: string
    Task command (e.g., archive.php, modify_xml.php, etc.; may be wildcarded)
  - Optionalcursor?: string
    Cursor for pagination
  - Optionalhistory?: 0 | 1
    A list of all completed tasks matching the supplied criteria
  - Optionalidentifier?: string
    The item identifier, if provided will return tasks for only this item filtered by other criteria provided in params.
  - Optionallimit?: number
    The current default is 50 tasks per request, but the caller may request more with the limit parameter The current maximum limit is 500 tasks. Values outside this range are clamped to the server maximum. If the caller wishes to receive all tasks in a single round-trip, they may set limit=0 in the request query.
    
    Default
    50
  - Optionalpriority?: number
    Generally from 10 to -10
  - Optionalserver?: string
    IA node task will or was executed upon (may be wildcarded)
  - Optionalsubmitter?: string
    User submitting task (may be wildcarded)
  - Optionalsubmittime<?: string
    Filter by submit time lower than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime<=?: string
    Filter by submit time lower or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>?: string
    Filter by submit time greater than supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsubmittime>=?: string
    Filter by submit time greater or equal to supplied time. Time must be formatted as "YYYY-MM-DD"
  - Optionalsummary?: 0 | 1
    Total counts of catalog tasks meeting all criteria organized by run status (queued, running, error, and paused). Historical totals are currently unavailable.
    
    Default
    1
  - Optionaltask_id?: number
    Task identifier
  - Optionalwait_admin?: number
    Task run state (see below)
Returns Promise<T>
Response

Throws
IaApiBadRequestError

Throws
IaApiUnauthorizedError

Throws
IaApiNotFoundError

Throws
IaApiMethodNotAllowedError

Throws
IaApiTooManyRequestsError
- Defined in src/catalog/IaCatalog.ts:84

submitTask

submitTask(param0: IaSubmitTaskParams): Promise<Response>
Beta
Submit a task

See submission
Parameters
- param0: IaSubmitTaskParams
  Options
  
  Params for the IaCatalog.submitTask method
  - Optionalargs?: Record<string, TODO>
    Extra POST data to submit with the request. Refer to Tasks API Request Entity
  - cmd: IaTaskType
    Task command to submit. See Supported task commands
  - Optionalcomment?: string
    A reasonable explanation for why the task is being submitted
  - Optionalheaders?: IaTaskRequestHttpHeaders
    Additional headers to add to the request
  - identifier: string
    Identifier
  - priority: IaTaskPriority
    Task priority from 10 to -10
Returns Promise<Response>
Response
- Defined in src/catalog/IaCatalog.ts:207

Class IaCatalogBeta

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IaCatalog

Properties

Readonly Betasession

Protected Readonly Betaurl

Methods

getRateLimit

Type Parameters

Parameters

Returns Promise< { cmd: T; tasks_blocked_by_offline: number; tasks_inflight: number; tasks_limit: number; },>

Throws

Throws

getSummary

Parameters

Optionalargs?: string

Optionalcmd?: string

Optionalcursor?: string

Optionallimit?: number

Default

Optionalpriority?: number

Optionalserver?: string

Optionalsubmitter?: string

Optionalsubmittime<?: string

Optionalsubmittime<=?: string

Optionalsubmittime>?: string

Optionalsubmittime>=?: string

Optionaltask_id?: number

Optionalwait_admin?: number

Returns Promise<IaTaskSummary>

Throws

getTasks

Parameters

Optionalargs?: string

Optionalcatalog?: 0 | 1

Optionalcmd?: string

Optionalcursor?: string

Optionalhistory?: 0 | 1

Optionalidentifier?: string

Optionalpriority?: number

Optionalserver?: string

Optionalsubmitter?: string

Optionalsubmittime<?: string

Optionalsubmittime<=?: string

Optionalsubmittime>?: string

Optionalsubmittime>=?: string

Optionaltask_id?: number

Optionalwait_admin?: number

Returns Promise<IaCatalogTask[]>

iterTasks

Parameters

Optionalargs?: string

Optionalcatalog?: 0 | 1

Optionalcmd?: string

Optionalcursor?: string

Optionalhistory?: 0 | 1

Optionalidentifier?: string

Optionallimit?: number

Default

Optionalpriority?: number

Optionalserver?: string

Optionalsubmitter?: string

Optionalsubmittime<?: string

Optionalsubmittime<=?: string

Optionalsubmittime>?: string

Optionalsubmittime>=?: string

Optionalsummary?: 0 | 1

Default

Optionaltask_id?: number

Optionalwait_admin?: number

Returns AsyncGenerator<IaCatalogTask>

iterTasksNoLimit

Parameters

Class IaCatalog`Beta`

`Readonly` `Beta`session

`Protected` `Readonly` `Beta`url

Returns Promise<
{
cmd: T;
tasks_blocked_by_offline: number;
tasks_inflight: number;
tasks_limit: number;
},
>

`Optional`args?: string

`Optional`cmd?: string

`Optional`cursor?: string

`Optional`limit?: number

`Optional`priority?: number

`Optional`server?: string

`Optional`submitter?: string

`Optional`submittime<?: string

`Optional`submittime<=?: string

`Optional`submittime>?: string

`Optional`submittime>=?: string

`Optional`task_id?: number

`Optional`wait_admin?: number

`Optional`args?: string

`Optional`catalog?: 0 | 1

`Optional`cmd?: string

`Optional`cursor?: string

`Optional`history?: 0 | 1

`Optional`identifier?: string

`Optional`priority?: number

`Optional`server?: string

`Optional`submitter?: string

`Optional`submittime<?: string

`Optional`submittime<=?: string

`Optional`submittime>?: string

`Optional`submittime>=?: string

`Optional`task_id?: number

`Optional`wait_admin?: number

`Optional`args?: string

`Optional`catalog?: 0 | 1

`Optional`cmd?: string

`Optional`cursor?: string

`Optional`history?: 0 | 1

`Optional`identifier?: string

`Optional`limit?: number

`Optional`priority?: number

`Optional`server?: string

`Optional`submitter?: string

`Optional`submittime<?: string

`Optional`submittime<=?: string

`Optional`submittime>?: string

`Optional`submittime>=?: string

`Optional`summary?: 0 | 1

`Optional`task_id?: number

`Optional`wait_admin?: number

`Optional`args?: string

`Optional`catalog?: 0 | 1

`Optional`cmd?: string

`Optional`cursor?: string

`Optional`history?: 0 | 1

`Optional`identifier?: string

`Optional`priority?: number

`Optional`server?: string

`Optional`submitter?: string

`Optional`submittime<?: string

`Optional`submittime<=?: string

`Optional`submittime>?: string

`Optional`submittime>=?: string

`Optional`task_id?: number

`Optional`wait_admin?: number

`Protected`makeTasksRequest

`Optional`args?: string

`Optional`catalog?: 0 | 1

`Optional`cmd?: string

`Optional`cursor?: string

`Optional`history?: 0 | 1

`Optional`identifier?: string

`Optional`limit?: number

`Optional`priority?: number

`Optional`server?: string

`Optional`submitter?: string

`Optional`submittime<?: string

`Optional`submittime<=?: string

`Optional`submittime>?: string

`Optional`submittime>=?: string

`Optional`summary?: 0 | 1