Class DGAmplifyTools

A class that contains methods for interacting with the Amplify API

Hierarchy (View Summary)

default
- DGAmplifyTools
  - FLEXAdminAllRuns

Index

Constructors

constructor

new DGAmplifyTools(isDev?: boolean): DGAmplifyTools
- Public Methods **
Parameters
- isDev: boolean = true
Returns DGAmplifyTools
Overrides default.constructor
- Defined in src/Model/Databases/DGAmplify.m.ts:98

Properties

`Protected`_ctx

_ctx: FLEXContextVariables

Member

ctx

Accessors

amplify

get amplify(): Client
Returns Client
Inherited from DGUtility.amplify
- Defined in src/Model/DGUtility.m.ts:86
set amplify(amplify: Client): void
Parameters
- amplify: Client
Returns void
Inherited from DGUtility.amplify
- Defined in src/Model/DGUtility.m.ts:74

ctx

get ctx(): FLEXContextVariables
Returns FLEXContextVariables
Inherited from DGUtility.ctx
- Defined in src/Model/DGUtility.m.ts:82
set ctx(ctx: FLEXContextVariables): void
Parameters
- ctx: FLEXContextVariables
Returns void
Inherited from DGUtility.ctx
- Defined in src/Model/DGUtility.m.ts:78

errorFunction

set errorFunction(error: (errors: string[] | number[] | object[]) => void): void
Parameters
- error: (errors: string[] | number[] | object[]) => void
Returns void
Inherited from DGUtility.errorFunction
- Defined in src/Model/DGUtility.m.ts:70

Methods

`Protected`_error

_error(errors: string[] | number[] | object[]): void
- Protected Members **
Parameters
- errors: string[] | number[] | object[]
Returns void
Inherited from default._error
- Defined in src/Model/DGUtility.m.ts:22

`Protected`_errorFunction

_errorFunction(errors: string[] | number[] | object[]): void
Parameters
- errors: string[] | number[] | object[]
Returns void
Inherited from default._errorFunction
- Defined in src/Model/DGUtility.m.ts:42

`Protected`_init

_init(): void
- Protected Methods **
Returns void
Inherited from default._init
- Defined in src/Model/DGUtility.m.ts:38

avg

avg(arr: number[]): number
Averages an array of numbers
Parameters
- arr: number[]
  an array of numbers to average
Returns number
the average of the elements in the array
Inherited from default.avg
- Defined in src/Model/DGUtility.m.ts:60

createID

createID(): string | number[]
Generate a random string of characters to be used as a unique id

Returns string | number[]
the result of the call to the uuid function
Inherited from default.createID
- Defined in src/Model/DGElement.m.ts:30

deleteS3Object

deleteS3Object(
path: string,
handleError?: (errors: string[] | number[] | object[]) => void,
): Promise<boolean>
Parameters
- path: string
- handleError: (errors: string[] | number[] | object[]) => void = ...
  - (errors: string[] | number[] | object[]): void
    
    Protected Members **
    
    Parameters
    errors: string[] | number[] | object[]
    Returns void
Returns Promise<boolean>
- Defined in src/Model/Databases/DGAmplify.m.ts:180

executeLambda

executeLambda(
functionName: string,
functionArgs: any,
): Promise<{ logs: string; result: string }>
Executes a lambda function
Parameters
- functionName: string
  The name of the lambda function to execute
- functionArgs: any
  The arguments to pass to the lambda function
Returns Promise<{ logs: string; result: string }>
- The API response or error
- Defined in src/Model/Databases/DGAmplify.m.ts:47

getDB

getDB(): Client
Returns Client
the value of the db private member

See
DGAmplifyTools
Inherited from default.getDB
- Defined in src/Model/DGUtility.m.ts:66

getLambdaParams

getLambdaParams(functionName: string): Promise<{ logs: string; result: string }>
Get all the parameters for a lambda function
Parameters
- functionName: string
  The name of the lambda function to execute
Returns Promise<{ logs: string; result: string }>
See
this.executeLambda
- Defined in src/Model/Databases/DGAmplify.m.ts:110

getObjectPresignedUrl

getObjectPresignedUrl(
path: string,
handleError?: (errors: string[] | number[] | object[]) => void,
): Promise<string>
Parameters
- path: string
- handleError: (errors: string[] | number[] | object[]) => void = ...
  - (errors: string[] | number[] | object[]): void
    
    Protected Members **
    
    Parameters
    errors: string[] | number[] | object[]
    Returns void
Returns Promise<string>
- Defined in src/Model/Databases/DGAmplify.m.ts:148

isNumeric

isNumeric(n: string): boolean
Parameters
- n: string
Returns boolean
Inherited from default.isNumeric
- Defined in src/Model/DGUtility.m.ts:90

loadFromS3

loadFromS3(
path: string,
handleError?: (errors: string[] | number[] | object[]) => void,
): Promise<string>
Parameters
- path: string
- handleError: (errors: string[] | number[] | object[]) => void = ...
  - (errors: string[] | number[] | object[]): void
    
    Protected Members **
    
    Parameters
    errors: string[] | number[] | object[]
    Returns void
Returns Promise<string>
- Defined in src/Model/Databases/DGAmplify.m.ts:119

s3ObjectExists

s3ObjectExists(path: string): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>
- Defined in src/Model/Databases/DGAmplify.m.ts:165

saveToS3

saveToS3(path: string, data: File): Promise<boolean>
Parameters
- path: string
- data: File
Returns Promise<boolean>
- Defined in src/Model/Databases/DGAmplify.m.ts:133

Class DGAmplifyTools

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DGAmplifyTools

Properties

Protected_ctx

Member

Accessors

amplify

Returns Client

Parameters

Returns void

ctx

Returns FLEXContextVariables

Parameters

Returns void

errorFunction

Parameters

Returns void

Methods

Protected_error

Parameters

Returns void

Protected_errorFunction

Parameters

Returns void

Protected_init

Returns void

avg

Parameters

Returns number

createID

Returns string | number[]

deleteS3Object

Parameters

Parameters

Returns void

Returns Promise<boolean>

executeLambda

Parameters

Returns Promise<{ logs: string; result: string }>

getDB

Returns Client

See

getLambdaParams

Parameters

Returns Promise<{ logs: string; result: string }>

See

getObjectPresignedUrl

Parameters

Parameters

Returns void

Returns Promise<string>

isNumeric

Parameters

Returns boolean

loadFromS3

Parameters

Parameters

Returns void

Returns Promise<string>

s3ObjectExists

Parameters

Returns Promise<boolean>

saveToS3

Parameters

Returns Promise<boolean>

Settings

On This Page

`Protected`_ctx

`Protected`_error

`Protected`_errorFunction

`Protected`_init