Class GcsService

constructor

• new GcsService(
      googleStorage: Storage,
      gcpConfig: GcpConfigType,
      loggerFactory: WinstonLoggerFactory,
  ): GcsService

  Parameters

  • googleStorage: Storage
  • gcpConfig: GcpConfigType
  • loggerFactory: WinstonLoggerFactory

  Returns GcsService

ReadonlyloggerFactory

getBucket

• getBucket(name: string): Bucket

  Returns google storage bucket by name

  Parameters

  • name: string

    bucket name

  Returns Bucket

  google storage bucket

  Throws

  if bucket not found

  Example

  const bucket = this.gcsService.getBucket('hc-auth-assets');
  Copy

getBucketBy

• getBucketBy(opts: GetBucketByOptions): Bucket

  Returns google storage bucket by find options

  Parameters

  • opts: GetBucketByOptions

  Returns Bucket

  google storage bucket

  Throws

  if bucket not found

  Example

  const bucket = this.gcsService.getBucketBy({
   name: 'hc-auth-assets',
  });
  
  const bucket = this.gcsService.getBucketBy({
   alias: 'assets',
  });
  Copy

getBucketHost

• getBucketHost(alias: string): string

  Method is used to retrieve the host URL of a Google Cloud Storage bucket based on its alias.

  Parameters

  • alias: string

    bucket alias (e.g. 'assets')

  Returns string

  google storage bucket host

  Example

  const bucket = this.gcsService.getBucketHost('assets');
  
  // bucket = 'https://storage.googleapis.com/hc-auth-assets'
  Copy

hasBucket

• hasBucket(name: string): undefined | boolean

  Checks if bucket exists in config

  Parameters

  • name: string

    bucket name

  Returns undefined | boolean

  • true if bucket exists in config

isBucketValid

• isBucketValid(bucket: string): boolean

  Parameters

  • bucket: string

  Returns boolean

validateGCSLocation

• validateGCSLocation(mediaUrl: string): GCSLocation

  Parameters

  • mediaUrl: string

  Returns GCSLocation