Class SigaaHTTPSession

Hierarchy

SigaaHTTPSession

Implements

HTTPSession

Index

Constructors

constructor

Properties

Accessors

requestStacks

Methods

Constructors

constructor

new SigaaHTTPSession(url: string, cookiesController: CookiesController, pageCache: PageCache, requestStack: RequestStackController<Request, Page>): SigaaHTTPSession

- Defined in src/session/sigaa-http-session.ts:134
Parameters
- url: string
  
  base of all request, example: https://sigaa.ifsc.edu.br
- cookiesController: CookiesController
- pageCache: PageCache
- requestStack: RequestStackController<Request, Page>
Returns SigaaHTTPSession

Properties

Private requestPromises

requestPromises: RequestPromiseTracker[] = []

url

url: string

Accessors

requestStacks

get requestStacks(): RequestStacks<Request, Page>

- Defined in src/session/sigaa-http-session.ts:160
Returns RequestStacks<Request, Page>

Methods

afterDownloadRequest

afterDownloadRequest(url: URL, downloadPath: string, sessionHttpOptions: HTTPRequestOptions, finalPath: string): Promise<string>

Implementation of HTTPSession.afterDownloadRequest
- Defined in src/session/sigaa-http-session.ts:144
inheritdoc

Parameters
- url: URL
- downloadPath: string
- sessionHttpOptions: HTTPRequestOptions
- finalPath: string
Returns Promise<string>

afterHTTPOptions

afterHTTPOptions(link: URL, httpOptions: HTTPRequestOptions): Promise<HTTPRequestOptions>

Implementation of HTTPSession.afterHTTPOptions
- Defined in src/session/sigaa-http-session.ts:243
This is called to modify the request options TIP: You must at least insert the cookies.

Parameters
- link: URL
- httpOptions: HTTPRequestOptions
Returns Promise<HTTPRequestOptions>

afterSuccessfulRequest

afterSuccessfulRequest(page: SigaaPage): Promise<Page>

Implementation of HTTPSession.afterSuccessfulRequest
- Defined in src/session/sigaa-http-session.ts:211
it is called after a sigaa response, only if successful. Should return a page or throw an error.

Parameters
- page: SigaaPage
  
  Sigaa page
Returns Promise<Page>

afterUnsuccessfulRequest

afterUnsuccessfulRequest(err: Error, httpOptions: HTTPRequestOptions, body?: string | Buffer): Promise<Page>

Implementation of HTTPSession.afterUnsuccessfulRequest
- Defined in src/session/sigaa-http-session.ts:176
It is called after a error in request. You must return a page or throw an error.

Parameters
- err: Error
- httpOptions: HTTPRequestOptions
- Optional body: string | Buffer
Returns Promise<Page>

beforeDownloadRequest

beforeDownloadRequest(): Promise<null>

Implementation of HTTPSession.beforeDownloadRequest
- Defined in src/session/sigaa-http-session.ts:156
if returns string the download is suspended

Returns Promise<null>

beforeRequest

beforeRequest(url: URL, httpOptions: HTTPRequestOptions, requestBody?: string | Buffer, options?: SigaaRequestOptions): Promise<null | Page>

Implementation of HTTPSession.beforeRequest
- Defined in src/session/sigaa-http-session.ts:260
It is called before the request, it may be useful to delay. If you return a page, the answer will be the page and there will be no http request If it returns null, the request will continue as normal and if you want to suspend the request, it may generate an error.

Parameters
- url: URL
- httpOptions: HTTPRequestOptions
- Optional requestBody: string | Buffer
- Optional options: SigaaRequestOptions
Returns Promise<null | Page>

close

close(): void

Implementation of HTTPSession.close
- Defined in src/session/sigaa-http-session.ts:309
Flush all cookies and cache of session

Returns void

Private findAndRemovePromiseRequest

findAndRemovePromiseRequest(request: Request): null | RequestPromiseTracker

- Defined in src/session/sigaa-http-session.ts:194
inheritdoc

Parameters
- request: Request
Returns null | RequestPromiseTracker

getURL

getURL(path: string): URL

Implementation of HTTPSession.getURL
- Defined in src/session/sigaa-http-session.ts:169
Transforms a path in URL

Parameters
- path: string
Returns URL

Generated using TypeDoc