Class UrlInput

constructor

• new UrlInput(
      __namedParameters: { dispatcher?: Dispatcher; url: string },
  ): UrlInput

  Parameters

  • __namedParameters: { dispatcher?: Dispatcher; url: string }

  Returns UrlInput

Readonlydispatcher

Readonlyurl

asLocalInputSource

• asLocalInputSource(
      options?: {
          filename?: string;
          headers?: Record<string, string>;
          maxRedirects?: number;
          password?: string;
          token?: string;
          username?: string;
      },
  ): Promise<BytesInput>

  Downloads the URL content and returns it as a local bytes source.

  Parameters

  • options: {
        filename?: string;
        headers?: Record<string, string>;
        maxRedirects?: number;
        password?: string;
        token?: string;
        username?: string;
    } = {}

  Returns Promise<BytesInput>

init

• init(): Promise<void>

  Initializes this source by validating and storing the URL.

  Returns Promise<void>

saveToFile

• saveToFile(
      options: {
          filename?: string;
          filepath: string;
          headers?: Record<string, string>;
          maxRedirects?: number;
          password?: string;
          token?: string;
          username?: string;
      },
  ): Promise<string>

  Downloads the URL content and writes it to disk.

  Parameters

  • options: {
        filename?: string;
        filepath: string;
        headers?: Record<string, string>;
        maxRedirects?: number;
        password?: string;
        token?: string;
        username?: string;
    }

  Returns Promise<string>

StaticvalidateUrl

• validateUrl(url: string): void

  Validates that a URL is safe to fetch: scheme must be https.

  Parameters

  • url: string

  Returns void