Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional blob

blob: Blob

For uploading a file on the web, a JavaScript Blob to upload

Optional connectTimeout

connectTimeout: number

How long to wait for the initial connection.

Optional data

data: any

Optional fileDirectory

fileDirectory: Directory

Optionally, the directory to look for the file in.

If this option is used, filePath can be a relative path rather than absolute

Optional filePath

filePath: string

For uploading a file natively, the path to the file on disk to upload

Optional headers

headers: HttpHeaders

Optional method

method: string

name

name: string

The field name to upload the file with

Optional params

params: HttpParams

Optional readTimeout

readTimeout: number

How long to wait to read additional data. Resets each time new data is received

Optional responseType

responseType: HttpResponseType

This is used to parse the response appropriately before returning it to the requestee. If the response content-type is "json", this value is ignored.

Optional shouldEncodeUrlParams

shouldEncodeUrlParams: boolean

Use this option if you need to keep the URL unencoded in certain cases (already encoded, azure/firebase testing, etc.). The default is true.

url

url: string

The URL to upload the file to

Optional webFetchExtra

webFetchExtra: RequestInit

Extra arguments for fetch when running on the web

Generated using TypeDoc