Class UnologinRestApi

Hierarchy

UnologinRestApi

Index

Constructors

Properties

Methods

getAppUrl getUserDocument getUserDocuments queryToUrlSearchParams

Constructors

constructor

new UnologinRestApi(client: Pick<main, "request" | "getOptions">): UnologinRestApi
Parameters
- client: Pick<main, "request" | "getOptions">
Returns UnologinRestApi
- Defined in src/rest.ts:166

Properties

`Readonly` client

client: Pick<main, "request" | "getOptions">

Methods

getAppUrl

getAppUrl(): string
Returns
appUrl

Returns string
- Defined in src/rest.ts:176

getUserDocument

getUserDocument(handle: UserHandle): Promise<UserDocument<any>>
Get a specific user document.

Returns
user document
Parameters
- handle: UserHandle
  
  UserHandle
Returns Promise<UserDocument<any>>
- Defined in src/rest.ts:223

getUserDocuments

getUserDocuments(query?: object | URLSearchParams): GetCursor<UserDocument<any>>
Get a cursor for all users matching the provided query.

Returns
GetCursor
Parameters
- query: object | URLSearchParams = {}
  
  optional query according to the query schema
Returns GetCursor<UserDocument<any>>
- Defined in src/rest.ts:205

queryToUrlSearchParams

queryToUrlSearchParams(query: object): URLSearchParams
Returns
URLSearchParams
Parameters
- query: object
  
  query
Returns URLSearchParams
- Defined in src/rest.ts:185

Generated using TypeDoc