Class GoogleBucket

Google Cloud Storage Bucket

Implements

Bucket

Index

Constructors

Properties

bucketName storage

Methods

generateFileId generatePublicUrl generateSignedUrl generateUploadSignedUrl getBucketName getFile upload

Constructors

constructor

new GoogleBucket(__namedParameters): GoogleBucket
Parameters
- __namedParameters: GoogleBucketOptions
Returns GoogleBucket
- Defined in src/bucket/gcp/gcs.ts:25

Properties

`Private` bucketName

bucketName: string

`Private` storage

storage: Storage

Methods

generateFileId

generateFileId(fileName): string
generate file Id
Parameters
- fileName: string
  file name
Returns string
- file id
- Defined in src/bucket/gcp/gcs.ts:46

generatePublicUrl

generatePublicUrl(fileName): string
Generate public url
Parameters
- fileName: string
  file name
Returns string
- public url
- Defined in src/bucket/gcp/gcs.ts:55

generateSignedUrl

generateSignedUrl(fileName, expiresSec?): Promise<string>
Generate signed url of file
Parameters
- fileName: string
  file name
- expiresSec: number = ...
  expiration second default 1 hour
Returns Promise<string>
- signed url
Implementation of Bucket.generateSignedUrl
- Defined in src/bucket/gcp/gcs.ts:67

generateUploadSignedUrl

generateUploadSignedUrl(fileName, contentType, contentLength, expires?): Promise<string>
Generate signed url to upload the file
Parameters
- fileName: string
  file name
- contentType: string
  allowed content type
- contentLength: number
  allowed content length of the file
- expires: number = ...
  expiration time of the signed url in ms, default: 15 mins
Returns Promise<string>
- the signed url
Implementation of Bucket.generateUploadSignedUrl
- Defined in src/bucket/gcp/gcs.ts:90

getBucketName

getBucketName(): string
Returns string
- bucket name
Implementation of Bucket.getBucketName
- Defined in src/bucket/gcp/gcs.ts:37

getFile

getFile(fileName): Promise<FileMeta>
Get file meta data
Parameters
- fileName: string
  file name
Returns Promise<FileMeta>
- file meta data
Implementation of Bucket.getFile
- Defined in src/bucket/gcp/gcs.ts:162

upload

upload(fileName, data): Promise<FileMeta>
Upload file data
Parameters
- fileName: string
  file name
- data: Buffer
  file data
Returns Promise<FileMeta>
- file meta data
Implementation of Bucket.upload
- Defined in src/bucket/gcp/gcs.ts:117

Generated using TypeDoc