modules
@auvious/common / Exports
@auvious/common
Description
auvious-common module of the Auvious APIs
Includes implementations regarding.
- logging
- http requests
- authentication
This file is the entry point for all public APIs.
It only reexports content of the src
folder. Keep it that way.
Table of contents
Classes
- ApiResource
- ApiResourceModel
- ApiResourceModelArray
- ApiSearchResource
- ApiSearchResult
- ApiUserResource
- AuviousCommon
- AuviousError
- AuviousEventClient
- Event
- EventClient
- EventClientHandlers
- GuestUser
- Logger
- OAuth2Client
- OAuth2ClientHandlers
- OAuth2Grant
- OAuth2Token
- PagedCollection
- Postman
- Serializer
- User
- Util
Interfaces
- DomainEvent
- IApiSearchResult
- IApiSearchResultContent
- IApiSearchResultPage
- IAuviousClientArgs
- IEventClientSubscription
- IEventClientSubscriptionDisposer
- IGuestUser
- IJwtTokenResponse
- IOAuth2Token
- IPagedCollection
- IUser
- SignedUrl
- SignedUrlProvider
Variables
Functions
Variables
CREATE_INTERNAL_SIGNED_URL_HEADER
• Const
CREATE_INTERNAL_SIGNED_URL_HEADER: "X-Auvious-CreateInternalSignedUrl"
TRANSACTION_ID_HEADER
• Const
TRANSACTION_ID_HEADER: "X-Auvious-TransactionId"
timers
• Const
timers: { clearInterval
: (id
: number
) => void
; clearTimeout
: (id
: number
) => void
; setInterval
: (func
: any
, delay
: number
) => number
; setTimeout
: (func
: any
, delay
: number
) => number
} | { clearInterval
: (id?
: number
) => void
(id?
: number
) => void
(intervalId
: Timeout
) => void
; clearTimeout
: (id?
: number
) => void
(id?
: number
) => void
(timeoutId
: Timeout
) => void
; setInterval
: (handler
: TimerHandler
, timeout?
: number
, ...arguments
: any
[]) => number
(handler
: TimerHandler
, timeout?
: number
, ...arguments
: any
[]) => number
(callback
: (...args
: any
[]) => void
, ms?
: number
, ...args
: any
[]) => NodeJS.Timeout
; setTimeout
: typeof setTimeout
}
Timer utilities, which use web worker if available, for more precision.
Functions
delayUsingSetTimeout
▸ delayUsingSetTimeout(ms
): Promise
<void
>
Delay using a worker timer if availabe.
Parameters
Name | Type | Description |
---|---|---|
ms | number | millis to wait |
Returns
Promise
<void
>
a promise which resolves after ms millis