Interface ReleaseAction<T>

The object returned by the Releases API

interface ReleaseAction<T> {
    action: T;
    sys: ReleaseActionSysProps;
    get(): ReleaseAction<any>;
    toPlainObject(): ReleaseActionProps<T>;
    waitProcessing(options?: AsyncActionProcessingOptions): ReleaseAction<any>;
}

Type Parameters

T extends ReleaseActionTypes = any

Hierarchy (view full)

ReleaseActionProps<T>
ReleaseActionApiMethods
DefaultElements<ReleaseActionProps<T>>
- ReleaseAction

Index

Properties

Methods

get toPlainObject waitProcessing

Properties

action

action: T

sys

sys: ReleaseActionSysProps

Methods

get

get(): ReleaseAction<any>
Performs a new GET request and returns the wrapper Release

Returns ReleaseAction<any>
Inherited from ReleaseActionApiMethods.get
- Defined in lib/entities/release-action.ts:53

toPlainObject

toPlainObject(): ReleaseActionProps<T>
Returns ReleaseActionProps<T>
Inherited from DefaultElements.toPlainObject
- Defined in lib/common-types.ts:190

waitProcessing

waitProcessing(options?): ReleaseAction<any>
Waits until the Release Action has either succeeded or failed
Parameters
- Optionaloptions: AsyncActionProcessingOptions
Returns ReleaseAction<any>
Inherited from ReleaseActionApiMethods.waitProcessing
- Defined in lib/entities/release-action.ts:55