Class IaAdvancedSearch<Fields>`Beta`

This class represents an archive.org item search using the advancedSearch API endpoint.

Example

import { IaSearch } from "internetarchive-ts";

const search = new IaAdvancedSearch(session, 'computer chronicles');

console.log(`Results: ${await search.getNumFound()}`)
for await (const result of search.getResultsGenerator()) {
    console.log(result);
}

Type Parameters

const Fields extends string[] | undefined
Search fields, inferred by the search params. If not supplied, a default set of fields will be returned

Hierarchy

IaBaseSearch<IaAdvancedSearchResult>
- IaAdvancedSearch

Index

Constructors

constructor

new IaAdvancedSearch<const Fields extends string[] | undefined>(
    session: IaSession,
    query: string,
    param2?: {
        fields?: Fields;
        limit?: number;
        maxRetries?: number;
        rows?: number;
        scope?: IaScope;
        sorts?:
            | []
            | [IaSortOption]
            | [IaSortOption, IaSortOption]
            | [IaSortOption, IaSortOption, IaSortOption];
    },
): IaAdvancedSearch<Fields>
Beta
Create a new advanced search
Type Parameters
- const Fields extends string[] | undefined
  Search fields, inferred by the search params. If not supplied, a default set of fields will be returned
Parameters
- session: IaSession
  Session to use for API requests
- query: string
  Search query
- param2: {
      fields?: Fields;
      limit?: number;
      maxRetries?: number;
      rows?: number;
      scope?: IaScope;
      sorts?:
          | []
          | [IaSortOption]
          | [IaSortOption, IaSortOption]
          | [IaSortOption, IaSortOption, IaSortOption];
  } = {}
  - Optionalfields?: Fields
    Fields to include in the results. If not supplied, a standard set of fields will be returned. Regardless of which fields are supplied, the "identifier" field will always be included.
  - Optionallimit?: number
    Maximum number of retries for each API call (default: 5)
  - OptionalmaxRetries?: number
  - Optionalrows?: number
  - Optionalscope?: IaScope
    The scope of the query. Possible values are 'standard' or 'all'. The 'all' scope requires authorization
  - Optionalsorts?:
        | []
        | [IaSortOption]
        | [IaSortOption, IaSortOption]
        | [IaSortOption, IaSortOption, IaSortOption]
    Up to 3 sort options
Returns IaAdvancedSearch<Fields>
Overrides IaBaseSearch<IaAdvancedSearchResult>.constructor
- Defined in src/search/IaAdvancedSearch.ts:56

Properties

`Protected` `Readonly` `Beta`basicParams

basicParams: IaAdvancedSearchParams

`Protected` `Optional` `Readonly` `Beta`fields

fields?: string[]

`Protected` `Optional` `Readonly` `Beta`limit

limit?: number

`Protected` `Readonly` `Beta`maxRetries

maxRetries: number

`Protected` `Beta`numFound

numFound: number | undefined

`Protected` `Readonly` `Beta`params

params: IaAdvancedSearchParams

`Protected` `Beta`query

query: string

`Protected` `Readonly` `Beta`session

session: IaSession

`Protected` `Readonly` `Beta`sorts

sorts: IaSortOption[]

`Protected` `Readonly` `Beta`url

url: string

Methods

`Protected`fetchNumFound

fetchNumFound(): Promise<number>
Beta
Fetches the number of results for the query of this instance.

Returns Promise<number>
Number of results for this search
Overrides IaBaseSearch.fetchNumFound
- Defined in src/search/IaAdvancedSearch.ts:235

getAggregations

getAggregations<const AggFields extends IaAggregatableField[]>(
aggFields: AggFields,
aggsSize?: number,
): Promise<IaUserAggs<AggFields>>
Beta
Return aggregations for the specified fields For each supplied field, up to 25 buckets will be returned.

This only works on specific fields. These are defined in IA_AGGREGATABLE_FIELDS
Type Parameters
- const AggFields extends IaAggregatableField[]
  Array of fields to aggregate
Parameters
- aggFields: AggFields
  fields to return aggregations for
- OptionalaggsSize: number
  number of aggregations to return (Default 25)
Returns Promise<IaUserAggs<AggFields>>
Record where the keys are the requested fields and the values are object containing the corresponding aggregations

Throws
IaApiError

Throws
IaTypeError

Throws
IaApiElasticSearchError
- Defined in src/search/IaAdvancedSearch.ts:178

getItemsGenerator

getItemsGenerator(): AsyncGenerator<
IaItem<IaBaseMetadataType, IaBaseMetadataType>,
>
Beta
A wrapper for IaAdvancedSearch.getResultsGenerator which fetches the corresponding IaItem for each result and yields it

Returns AsyncGenerator<IaItem<IaBaseMetadataType, IaBaseMetadataType>>
Generator which yields Items
Overrides IaBaseSearch.getItemsGenerator
- Defined in src/search/IaAdvancedSearch.ts:224

getNumFound

getNumFound(): Promise<number>
Beta
Get the number if items found by this query.

Note that this number can change over time. The number also gets updated with every call to the search API.

Returns Promise<number>
Number of items found
Inherited from IaBaseSearch.getNumFound
- Defined in src/search/IaBaseSearch.ts:25

getResults

getResults(page?: number): Promise<IaAdvancedSearchResult<Fields>>
Beta
Get a single page of results. This method also updates the numFound value.
Parameters
- Optionalpage: number
  Page number
Returns Promise<IaAdvancedSearchResult<Fields>>
Search Result object
- Defined in src/search/IaAdvancedSearch.ts:107

getResultsGenerator

getResultsGenerator(): AsyncGenerator<
    Fields extends readonly string[]
        ? IaSearchResultMetaItem<Fields<Fields>[number] & "identifier">
        : IaDefaultAdvancedSearchResultItem,
>
Beta
Create a generator that yields search results. The maximum amount of results returned can be defined by limit. If limit is not set, all results will be returned, which may require a lot of slow requests to be made to fetch all results.

Returns AsyncGenerator<
    Fields extends readonly string[]
        ? IaSearchResultMetaItem<Fields<Fields>[number] & "identifier">
        : IaDefaultAdvancedSearchResultItem,
>
AsyncGenerator which yields one search result at a time.

Throws
IaApiError

Throws
IaApiRangeError
- Defined in src/search/IaAdvancedSearch.ts:134

length

length(): Promise<number>
Beta
Returns Promise<number>
Inherited from IaBaseSearch.length
- Defined in src/search/IaBaseSearch.ts:28

toString

toString(): string
Beta
Returns string
Inherited from IaBaseSearch.toString
- Defined in src/search/IaBaseSearch.ts:11

Class IaAdvancedSearch<Fields>Beta

Example

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Optionalfields?: Fields

Optionallimit?: number

OptionalmaxRetries?: number

Optionalrows?: number

Optionalscope?: IaScope

Optionalsorts?: | [] | [IaSortOption] | [IaSortOption, IaSortOption] | [IaSortOption, IaSortOption, IaSortOption]

Returns IaAdvancedSearch<Fields>

Properties

Protected Readonly BetabasicParams

Protected Optional Readonly Betafields

Protected Optional Readonly Betalimit

Protected Readonly BetamaxRetries

Protected BetanumFound

Protected Readonly Betaparams

Protected Betaquery

Protected Readonly Betasession

Protected Readonly Betasorts

Protected Readonly Betaurl

Methods

ProtectedfetchNumFound

Returns Promise<number>

getAggregations

Type Parameters

Parameters

Returns Promise<IaUserAggs<AggFields>>

Throws

Throws

Throws

getItemsGenerator

Returns AsyncGenerator<IaItem<IaBaseMetadataType, IaBaseMetadataType>>

getNumFound

Returns Promise<number>

getResults

Parameters

Returns Promise<IaAdvancedSearchResult<Fields>>

getResultsGenerator

Returns AsyncGenerator< Fields extends readonly string[] ? IaSearchResultMetaItem<Fields<Fields>[number] & "identifier"> : IaDefaultAdvancedSearchResultItem,>

Throws

Throws

length

Returns Promise<number>

toString

Returns string

Settings

On This Page

Class IaAdvancedSearch<Fields>`Beta`

`Optional`fields?: Fields

`Optional`limit?: number

`Optional`maxRetries?: number

`Optional`rows?: number

`Optional`scope?: IaScope

`Optional`sorts?:
| []
| [IaSortOption]
| [IaSortOption, IaSortOption]
| [IaSortOption, IaSortOption, IaSortOption]

`Protected` `Readonly` `Beta`basicParams

`Protected` `Optional` `Readonly` `Beta`fields

`Protected` `Optional` `Readonly` `Beta`limit

`Protected` `Readonly` `Beta`maxRetries

`Protected` `Beta`numFound

`Protected` `Readonly` `Beta`params

`Protected` `Beta`query

`Protected` `Readonly` `Beta`session

`Protected` `Readonly` `Beta`sorts

`Protected` `Readonly` `Beta`url

`Protected`fetchNumFound

Returns AsyncGenerator<
Fields extends readonly string[]
? IaSearchResultMetaItem<Fields<Fields>[number] & "identifier">
: IaDefaultAdvancedSearchResultItem,
>