Class DGAmplifyTools

A class that contains methods for interacting with the Amplify API

Hierarchy (View Summary)

default
- DGAmplifyTools

Index

Constructors

Properties

_ctx _errorFunction

Accessors

amplify ctx errorFunction

Methods

_error _init avg createID deleteS3Object executeLambda getDB getLambdaParams getObjectPresignedUrl isNumeric listS3Objects loadFromS3 s3ObjectExists saveToS3

Constructors

constructor

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

Properties

`Protected`_ctx

_ctx: FLEXContextVariables

Member

ctx

`Protected`_errorFunction

_errorFunction: (errors: string[] | number[] | object[]) => void = console.error

Accessors

amplify

get amplify(): Client
Returns Client
Inherited from Devices.amplify
- Defined in Model/DGUtility.m.ts:84
set amplify(amplify: Client): void
Parameters
- amplify: Client
Returns void
Inherited from Devices.amplify
- Defined in Model/DGUtility.m.ts:72

ctx

get ctx(): FLEXContextVariables
Returns FLEXContextVariables
Inherited from Devices.ctx
- Defined in Model/DGUtility.m.ts:80
set ctx(ctx: FLEXContextVariables): void
Parameters
- ctx: FLEXContextVariables
Returns void
Inherited from Devices.ctx
- Defined in Model/DGUtility.m.ts:76

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 Model/DGUtility.m.ts:68

Methods

`Protected`_error

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

`Protected`_init

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

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 Model/DGUtility.m.ts:58

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 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 = ...
Returns Promise<boolean>
- Defined in Model/Databases/DGAmplify.m.ts:206

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 Model/Databases/DGAmplify.m.ts:53

getDB

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

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

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 Model/Databases/DGAmplify.m.ts:116

getObjectPresignedUrl

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

isNumeric

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

listS3Objects

listS3Objects(path: string): Promise<ListPaginateWithPathOutput>
Parameters
- path: string
Returns Promise<ListPaginateWithPathOutput>
- Defined in Model/Databases/DGAmplify.m.ts:177

loadFromS3

loadFromS3(
path: string,
handleError?: (error: string | number | object) => void,
): Promise<string>
Loads a text file from S3
Parameters
- path: string
  The S3 path to the file
- handleError: (error: string | number | object) => void = ...
  The error handler
Returns Promise<string>
- The file contents
- Defined in Model/Databases/DGAmplify.m.ts:132

s3ObjectExists

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

saveToS3

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