Class UrlInput

Hierarchy (view full)

InputSource
- UrlInput

Index

Constructors

Properties

Methods

asLocalInputSource init saveToFile

Constructors

constructor

new UrlInput(__namedParameters): UrlInput
Parameters
- __namedParameters: {
  url: string;
  }
  - url: string
Returns UrlInput
Overrides InputSource.constructor
- Defined in src/input/sources/urlInput.ts:13

Properties

fileObject

fileObject: string | Buffer = ""

Methods

asLocalInputSource

asLocalInputSource(options?): Promise<BytesInput>
Parameters
- options: {
      filename?: string;
      headers?: Record<string, string>;
      maxRedirects?: number;
      password?: string;
      token?: string;
      username?: string;
  } = {}
  - Optionalfilename?: string
  - Optionalheaders?: Record<string, string>
  - OptionalmaxRedirects?: number
  - Optionalpassword?: string
  - Optionaltoken?: string
  - Optionalusername?: string
Returns Promise<BytesInput>
- Defined in src/input/sources/urlInput.ts:60

init

init(): Promise<void>
Returns Promise<void>
Overrides InputSource.init
- Defined in src/input/sources/urlInput.ts:18

saveToFile

saveToFile(options): Promise<string>
Parameters
- options: {
      filename?: string;
      filepath: string;
      headers?: Record<string, string>;
      maxRedirects?: number;
      password?: string;
      token?: string;
      username?: string;
  }
  - Optionalfilename?: string
  - filepath: string
  - Optionalheaders?: Record<string, string>
  - OptionalmaxRedirects?: number
  - Optionalpassword?: string
  - Optionaltoken?: string
  - Optionalusername?: string
Returns Promise<string>
- Defined in src/input/sources/urlInput.ts:43