Class Socket

Hierarchy

Socket

Index

Constructors

constructor

Methods

Constructors

constructor

new Socket(url?: any): Socket

- Defined in socket.ts:39
Parameters
- Default value url: any = undefined
Returns Socket

Methods

get

get(uri: string | string[]): SuperAgentRequest

- Defined in socket.ts:126
Create a GET request to Dicoogle.

Parameters
- uri: string | string[]
  
  the URI to the intended service, relative to Dicoogle's base URL
Returns SuperAgentRequest

a superagent object for a new request to this service

getBase

getBase(): string

- Defined in socket.ts:162
Returns string

getRoles

getRoles(): string[] | null

- Defined in socket.ts:158
Returns string[] | null

getToken

getToken(): string | null

- Defined in socket.ts:146
Returns string | null

getUsername

getUsername(): string | null

- Defined in socket.ts:154
Returns string | null

hasToken

hasToken(): boolean

- Defined in socket.ts:166
Returns boolean

login

login(username: string, password: password): Promise<{ admin: boolean; roles: string[]; token: string; user: string }>

- Defined in socket.ts:66
Parameters
- username: string
- password: password
Returns Promise<{ admin: boolean; roles: string[]; token: string; user: string }>

logout

logout(): Promise<void>

- Defined in socket.ts:91
Returns Promise<void>

post

post(uri: string | string[]): SuperAgentRequest

- Defined in socket.ts:134
Create a POST request to Dicoogle.

Parameters
- uri: string | string[]
  
  the URI to the intended service, relative to Dicoogle's base URL
Returns SuperAgentRequest

a superagent object for a new request to this service

put

put(uri: string | string[]): SuperAgentRequest

- Defined in socket.ts:142
Create a PUT request to Dicoogle.

Parameters
- uri: string | string[]
  
  the URI to the intended service, relative to Dicoogle's base URL
Returns SuperAgentRequest

a superagent object for a new request to this service

request

request(method?: string, uri?: string | string[]): SuperAgentRequest

- Defined in socket.ts:114
Create a request to Dicoogle.

Parameters
- Default value method: string = "GET"
  
  the intended HTTP method ('GET', 'POST', ...)
- Optional uri: string | string[]
  
  the URI to the intended service, relative to Dicoogle's base URL
Returns SuperAgentRequest

a superagent object for a new request to this service

reset

reset(): void

- Defined in socket.ts:170
Returns void

restore

restore(token: string): Promise<UserInfo>

- Defined in socket.ts:79
Parameters
- token: string
Returns Promise<UserInfo>

setToken

setToken(token: string | null): void

- Defined in socket.ts:150
Parameters
- token: string | null
Returns void

Generated using TypeDoc