storage

This modules provides methods manage object storage in Google Cloud Storage.

How to use

$3

``typescript
import { FileStorage } from 'storage'
`

$3

First, we need an instance of FileStorage

`typescript
export const fileStorage = new FileStorage({
bucket: 'BUCKET_NAME',
keyFilename: 'STORAGE_KEY_FILENAME',
})
`

- STORAGE_KEY_FILENAME is the credential file URI

$3

Upload a file to the remote storage.

`typescript
const fileName = await fileStorage.upload(
{
pathDestination: 'path',
fileName: 'testFile',
file: Buffer.from('Test content', 'utf-8'),
contentType: "text/plain"
metadata: { something: 'here' }
}
)

// fileName -> path/testFile
`

`typescript
// OR
const fileName = await fileStorage.send(
{
pathDestination: 'path',
fileName: 'testFile',
file: fs.createReadStream('./test.png'),
contentType: "img/png"
metadata: { something: 'here' }
}
)

// fileName -> path/testFile
`

- The file attribute MUST be a Buffer or a ReadableStream.
- The contentType attribute is not required default to "application/octet-stream"
- The metadata object is not required. Values are converted to string

$3

Download a file from the bucket

`typescript
const fileBuffer = await fileStorage.download(fileName)
`

- fileName is the string returned by the upload() method

$3

#### getMetadata

Get the global metadata of an object

`typescript
const metadata = await fileStorage.getMetadata(fileName)

/*
metadata ->
{ kind: 'storage#object',
id: 'sandbox',
selfLink:
'https://www.googleapis.com/storage/v1/b/BUCKET_NAME/o/path%2FtestFile',
name: 'path/testFile',
bucket: 'BUCKET_NAME',
generation: '123456789',
metageneration: '1',
contentType: 'application/octet-stream',
storageClass: 'STANDARD',
size: '12',
md5Hash: 'MD5_HASH',
mediaLink:
'https://storage.googleapis.com/download/storage/v1/b/BUCKET_NAME/o/path%2FtestFile?generation=123456789&alt=media',
cacheControl: 'public, max-age=31536000',
crc32c: 'r5b9xg==',
etag: 'CJD+6K2xsuUCEAE=',
timeCreated: '2019-10-23T12:30:40.811Z',
updated: '2019-10-23T12:30:40.811Z',
timeStorageClassUpdated: '2019-10-23T12:30:40.811Z'
metadata: { something: 'here', type: 'text' }
}

*/
`

- fileName is the string returned by the upload()` method