Documentation
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    ctx

    Accessors

    • set errorFunction(error: (errors: string[] | number[] | object[]) => void): void

      Parameters

      • error: (errors: string[] | number[] | object[]) => void

      Returns void

    Methods

      • Protected Members **

      Parameters

      • errors: string[] | number[] | object[]

      Returns void

    • Averages an array of numbers

      Parameters

      • arr: number[]

        an array of numbers to average

      Returns number

      the average of the elements in the array

    • 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

    • Parameters

      • fileObject: { file: object; key: string }

      Returns Promise<{ file: { name: string }; key: string }>

    • Parameters

      • imageURL: string
      • handleError: {
            (...data: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
        } = console.error
          • (...data: any[]): void
          • Parameters

            • ...data: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Prints to stderr with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

            const code = 5;
            console.error('error #%d', code);
            // Prints: error #5, to stderr
            console.error('error', code);
            // Prints: error 5, to stderr

            If formatting elements (e.g. %d) are not found in the first string then util.inspect() is called on each argument and the resulting string values are concatenated. See util.format() for more information.

            Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

            v0.1.100

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

      Returns Promise<GetPropertiesWithPathOutput>

    • Parameters

      • imageURL: string
      • bucketPrefix: string = "public"
      • urlIncludesPrefix: boolean = false
      • handleError: {
            (...data: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
        } = console.error
          • (...data: any[]): void
          • Parameters

            • ...data: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Prints to stderr with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

            const code = 5;
            console.error('error #%d', code);
            // Prints: error #5, to stderr
            console.error('error', code);
            // Prints: error 5, to stderr

            If formatting elements (e.g. %d) are not found in the first string then util.inspect() is called on each argument and the resulting string values are concatenated. See util.format() for more information.

            Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

            v0.1.100

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

      Returns Promise<boolean>

    • Parameters

      • image: File
      • bucketPrefix: string = "public"
      • onProgress: {
            (...data: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
        } = console.log
          • (...data: any[]): void
          • Parameters

            • ...data: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Prints to stdout with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

            const count = 5;
            console.log('count: %d', count);
            // Prints: count: 5, to stdout
            console.log('count:', count);
            // Prints: count: 5, to stdout

            See util.format() for more information.

            Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

            v0.1.100

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

      • handleError: {
            (...data: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
        } = console.error
          • (...data: any[]): void
          • Parameters

            • ...data: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Prints to stderr with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

            const code = 5;
            console.error('error #%d', code);
            // Prints: error #5, to stderr
            console.error('error', code);
            // Prints: error 5, to stderr

            If formatting elements (e.g. %d) are not found in the first string then util.inspect() is called on each argument and the resulting string values are concatenated. See util.format() for more information.

            Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

            v0.1.100

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

      Returns Promise<string>

    • Parameters

      • imageURL: string
      • handleError: {
            (...data: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
            (message?: any, ...optionalParams: any[]): void;
        } = console.error
          • (...data: any[]): void
          • Parameters

            • ...data: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Prints to stderr with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

            const code = 5;
            console.error('error #%d', code);
            // Prints: error #5, to stderr
            console.error('error', code);
            // Prints: error 5, to stderr

            If formatting elements (e.g. %d) are not found in the first string then util.inspect() is called on each argument and the resulting string values are concatenated. See util.format() for more information.

            Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

            v0.1.100

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

          • (message?: any, ...optionalParams: any[]): void
          • Parameters

            • Optionalmessage: any
            • ...optionalParams: any[]

            Returns void

      Returns Promise<StorageGetUrlOutput>