Options
All
  • Public
  • Public/Protected
  • All
Menu

Class S3Nest

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new S3Nest(e: Environment, bucket: string, keyPrefix?: string, checkEvery?: number, allowCreation?: boolean): S3Nest

  • Constructor

    Parameters

    • e: Environment
    • bucket: string

      AWS S3 bucket to watch.

    • Optional keyPrefix: string

      Optional key prefix (sub-directory) to watch.

    • Default value checkEvery: number = 5

      Frequency of bucket checking, in minutes.

    • Default value allowCreation: boolean = false

      Create the bucket:prefix if it does not exist.

    Returns S3Nest

Properties

Protected _id

_id: string

Protected _name

_name: string

Protected _tunnel

_tunnel: Tunnel

Protected allowCreation

allowCreation: boolean

Protected bucket

bucket: string

Protected checkEvery

checkEvery: number

Protected checkEveryMs

checkEveryMs: number

Protected client

client: any

Protected e

e: Environment

Protected keyPrefix

keyPrefix: string

Protected s3

s3: any

Accessors

id

  • get id(): string

name

  • get name(): string
  • set name(name: string): void

tunnel

Methods

arrive

Private calculateRemaining

  • calculateRemaining(total: number, loaded: number, part?: number): number

  • Calculate the percent remaining from the httpUploadProgress event values.

    Parameters

    • total: number
    • loaded: number
    • Optional part: number

    Returns number

Protected createBucket

  • createBucket(callback: any): void

Protected deleteObject

  • deleteObject(key: any): void

Protected headBucket

  • headBucket(callback: any): void

  • Verify that the bucket is available and exists

    Parameters

    • callback: any

    Returns void

load

  • load(): void

register

  • register(tunnel: Tunnel): void

setCredentials

  • setCredentials(accessKeyId: string, secretAccessKey: string): void

  • Set hard-coded AWS credentials.

    Parameters

    • accessKeyId: string
    • secretAccessKey: string

    Returns void

take

  • take(job: FileJob, callback?: any): void

toString

  • toString(): string

Protected uploadFile

  • uploadFile(job: FileJob, callback: any): void

  • Upload file to S3

    Parameters

    • job: FileJob

      FileJob to be uploaded.

    • callback: any

      Callback includes the S3FileJob parameter.

    Returns void

Protected verifyBucket

  • verifyBucket(): void

watch

  • watch(): void

Generated using TypeDoc