Class AchFileS3Service

constructor

• new AchFileS3Service(
      __namedParameters: {
          s3AccessKey?: string;
          s3Bucket: string;
          s3Region: string;
          s3Secret?: string;
      },
  ): AchFileS3Service

  Parameters

  • __namedParameters: { s3AccessKey?: string; s3Bucket: string; s3Region: string; s3Secret?: string }

  Returns AchFileS3Service

Readonlys3Bucket

deleteFile

• deleteFile(key: string): Promise<void>

  Parameters

  • key: string

  Returns Promise<void>

downloadFile

• downloadFile(key: string): Promise<Buffer<ArrayBufferLike> | null>

  Parameters

  • key: string

  Returns Promise<Buffer<ArrayBufferLike> | null>

generateDownloadLink

• generateDownloadLink(key: string, expiresIn?: number): Promise<string>

  Parameters

  • key: string
  • expiresIn: number = 3600

  Returns Promise<string>

getBucketName

• getBucketName(): string

  Returns string

getConfig

• getConfig(): {
      s3AccessKey: string
      | undefined;
      s3Bucket: string;
      s3Region: string;
      s3Secret: string | undefined;
  }

  Returns {
      s3AccessKey: string | undefined;
      s3Bucket: string;
      s3Region: string;
      s3Secret: string | undefined;
  }

listFiles

• listFiles(prefix: string): Promise<string[]>

  Parameters

  • prefix: string

  Returns Promise<string[]>

moveFile

• moveFile(sourceKey: string, destinationKey: string): Promise<void>

  Parameters

  • sourceKey: string
  • destinationKey: string

  Returns Promise<void>

uploadFile

• uploadFile(key: string, body: Readable | Buffer<ArrayBufferLike>): Promise<void>

  Parameters

  • key: string
  • body: Readable | Buffer<ArrayBufferLike>

  Returns Promise<void>