Interface HTTP

instance

Hierarchy

HTTP

Implemented by

Index

Methods

Methods

closeSession

closeSession(): void

- Defined in src/session/sigaa-http.ts:124
Close http session

Returns void

downloadFileByGet

downloadFileByGet(urlPath: string, destpath: string, callback?: ProgressCallback): Promise<string>

- Defined in src/session/sigaa-http.ts:95
Download a file

Parameters
- urlPath: string
  
  file url
- destpath: string
  
  path to save file
- Optional callback: ProgressCallback
  
  callback to view download progress
Returns Promise<string>

downloadFileByPost

downloadFileByPost(urlPath: string, postValues: Record<string, string>, basepath: string, callback?: ProgressCallback): Promise<string>

- Defined in src/session/sigaa-http.ts:107
Download a file

Parameters
- urlPath: string
  
  file url
- postValues: Record<string, string>
- basepath: string
  
  path to save file
- Optional callback: ProgressCallback
  
  callback to view download progress
Returns Promise<string>

followAllRedirect

followAllRedirect(page: Page, options?: SigaaRequestOptions): Promise<Page>

- Defined in src/session/sigaa-http.ts:119
Follow the redirect while the page response redirects to another page

Parameters
- page: Page
- Optional options: SigaaRequestOptions
Returns Promise<Page>

The last page of redirects

get

get(path: string, options?: SigaaRequestOptions): Promise<Page>

- Defined in src/session/sigaa-http.ts:87
Make a GET request

Parameters
- path: string
  
  The path of request or full URL
- Optional options: SigaaRequestOptions
Returns Promise<Page>

post

post(path: string, postValues: Record<string, string>, options?: SigaaRequestOptions): Promise<Page>

- Defined in src/session/sigaa-http.ts:74
Make a POST request

Parameters
- path: string
  
  The path of request or full URL
- postValues: Record<string, string>
  
  Post values in format, key as field name, and value as field value.
- Optional options: SigaaRequestOptions
Returns Promise<Page>

postMultipart

postMultipart(path: string, formData: FormData, options?: SigaaRequestOptions): Promise<Page>

- Defined in src/session/sigaa-http.ts:60
Make a POST multipart request

Parameters
- path: string
  
  The path of request or full URL
- formData: FormData
  
  instance of FormData
- Optional options: SigaaRequestOptions
Returns Promise<Page>

Generated using TypeDoc