BaseApi

Interfaces

SuccessResponse

interface SuccessResponse {
    success: boolean,
    message: string
}

Members

user : User

The User that this API is associated with.

apiUrl : string

The base URL of this API.

Methods

constructor(user, apiUrl)

This should only get called by classes that inherit the BaseApi class.

• user should be an instance of the User object.
• apiUrl should be the base API URL.

class SomeVulosIdentityApi extends BaseApi {
    constructor(user, endpoint) {
        super(user, endpoint + '/api/v1/some_api')
    }
}

const someApi = new SomeVulosIdentityApi(user, endpoint)

async request(url, method = 'get', data = null, cachePrefix = null)

Preform an authenticated request to the API.

const response = await someApi.request('endpoint', 'put', { key: 'value' }, 'some:endpoint')