Rename method set to put

README.md

@@ -53,7 +53,7 @@ interface Bucket {
    * @param key The path to the file.
    * @param content The contents of the file.
    */
-  set(key: string, content: Uint8Array | string): Promise<void>;
+  put(key: string, content: Uint8Array | string): Promise<void>;
 
   /**
    * Delete a file.
@@ -83,7 +83,7 @@ console.log(hasFile);
 const fileContent = await localBucket.get('file.txt');
 console.log(fileContent);
 
-await localBucket.set('file.txt', 'Hello, World!');
+await localBucket.put('file.txt', 'Hello, World!');
 
 await localBucket.delete('file.txt');
 ```
@@ -114,7 +114,7 @@ console.log(hasFile);
 const fileContent = await s3Bucket.get('file.txt');
 console.log(fileContent);
 
-await s3Bucket.set('file.txt', 'Hello, S3!');
+await s3Bucket.put('file.txt', 'Hello, S3!');
 
 await s3Bucket.delete('file.txt');
 ```
@@ -154,7 +154,7 @@ console.log(hasFile);
 const fileContent = await azureBucket.get('file.txt');
 console.log(fileContent);
 
-await azureBucket.set('file.txt', 'Hello, Azure!');
+await azureBucket.put('file.txt', 'Hello, Azure!');
 
 await azureBucket.delete('file.txt');
 ```
@@ -192,7 +192,7 @@ console.log(hasFile);
 const fileContent = await gcsBucket.get('file.txt');
 console.log(fileContent);
 
-await gcsBucket.set('file.txt', 'Hello, GCS!');
+await gcsBucket.put('file.txt', 'Hello, GCS!');
 
 await gcsBucket.delete('file.txt');
 ```

src/azure.ts

@@ -48,7 +48,7 @@ export default class AzureBucket implements Bucket {
     return encoding ? await body.text() : Buffer.from(await body.arrayBuffer());
   }
 
-  async set(key: string, content: string | Uint8Array): Promise<void> {
+  async put(key: string, content: string | Uint8Array): Promise<void> {
     const blobClient = this.container.getBlockBlobClient(this.path(key));
 
     if (typeof content === 'string') {

src/gcs.ts

@@ -38,7 +38,7 @@ export default class GCSBucket implements Bucket {
     return encoding ? data.toString(encoding) : data;
   }
 
-  async set(key: string, content: string | Uint8Array): Promise<void> {
+  async put(key: string, content: string | Uint8Array): Promise<void> {
     const file = this.bucket.file(this.path(key));
     await file.save(typeof content === 'string' ? content : Buffer.from(content));
   }

src/local.ts

@@ -26,7 +26,7 @@ export default class LocalBucket implements Bucket {
     return fs.readFile(this.path(key), encoding);
   }
 
-  async set(key: string, content: string | Uint8Array): Promise<void> {
+  async put(key: string, content: string | Uint8Array): Promise<void> {
     if (key === '') throw new Error('key is empty');
     const path = this.path(key);
 

src/s3.ts

@@ -61,7 +61,7 @@ export default class S3Bucket implements Bucket {
     return encoding ? await content.transformToString(encoding) : Buffer.from(await content.transformToByteArray());
   }
 
-  async set(key: string, content: string | Uint8Array): Promise<void> {
+  async put(key: string, content: string | Uint8Array): Promise<void> {
     const params = {
       Bucket: this.bucketName,
       Key: this.path(key),

src/types.ts

@@ -6,7 +6,7 @@ export interface Bucket {
   get(key: string, encoding?: null): Promise<Buffer>;
   get(key: string, encoding: BufferEncoding): Promise<string>;
 
-  set(key: string, content: string | Uint8Array): Promise<void>;
+  put(key: string, content: string | Uint8Array): Promise<void>;
 
   delete(key: string): Promise<void>;
 }

test/azure.spec.ts

@@ -178,7 +178,7 @@ describe('AzureBucket', () => {
     it('should put an object with the specified key and binary value', async () => {
       blockBlobClient.uploadData.resolves();
 
-      await bucket.set('file1.txt', Uint8Array.from([1, 2, 3]));
+      await bucket.put('file1.txt', Uint8Array.from([1, 2, 3]));
 
       expect(container.getBlockBlobClient.calledOnce).to.be.true;
       expect(container.getBlockBlobClient.firstCall.args[0]).to.equal('file1.txt');
@@ -190,7 +190,7 @@ describe('AzureBucket', () => {
     it('should put an object with the specified key and string value', async () => {
       blockBlobClient.upload.resolves();
 
-      await bucket.set('file1.txt', 'content 1');
+      await bucket.put('file1.txt', 'content 1');
 
       expect(container.getBlockBlobClient.calledOnce).to.be.true;
       expect(container.getBlockBlobClient.firstCall.args[0]).to.equal('file1.txt');
@@ -202,7 +202,7 @@ describe('AzureBucket', () => {
 
     describe('with prefix', () => {
       it('should put an object with the specified key and value', async () => {
-        await bucketSub.set('file1.txt', 'content 1');
+        await bucketSub.put('file1.txt', 'content 1');
 
         expect(container.getBlockBlobClient.calledOnce).to.be.true;
         expect(container.getBlockBlobClient.firstCall.args[0]).to.equal('sub/file1.txt');

test/gcs.spec.ts

@@ -162,7 +162,7 @@ describe('GCSBucket', () => {
     });
 
     it('should put an object with a string value', async () => {
-      await bucket.set('file1.txt', 'content 1');
+      await bucket.put('file1.txt', 'content 1');
 
       expect(gcsBucket.file.calledOnce).to.be.true;
       expect(gcsBucket.file.firstCall.args[0]).to.equal('file1.txt');
@@ -172,7 +172,7 @@ describe('GCSBucket', () => {
     });
 
     it('should put an object with a binary value', async () => {
-      await bucket.set('file1.txt', Uint8Array.from([1, 2, 3, 4]));
+      await bucket.put('file1.txt', Uint8Array.from([1, 2, 3, 4]));
 
       expect(gcsBucket.file.calledOnce).to.be.true;
       expect(gcsBucket.file.firstCall.args[0]).to.equal('file1.txt');
@@ -183,7 +183,7 @@ describe('GCSBucket', () => {
 
     describe('with prefix', () => {
       it('should put an object with a string value', async () => {
-        await bucketSub.set('file1.txt', 'content 1');
+        await bucketSub.put('file1.txt', 'content 1');
 
         expect(gcsBucket.file.calledOnce).to.be.true;
         expect(gcsBucket.file.firstCall.args[0]).to.equal('sub/file1.txt');

test/local.spec.ts

@@ -78,7 +78,7 @@ describe('LocalBucket', () => {
       const key = 'new-file.txt';
       const value = 'new file content';
 
-      await bucket.set(key, value);
+      await bucket.put(key, value);
       const content = await fs.readFile(`/base/path/${key}`, 'utf-8');
 
       expect(content).to.equal(value);
@@ -89,7 +89,7 @@ describe('LocalBucket', () => {
       const key = 'nested/folder/file.txt';
       const value = 'nested file content';
 
-      await bucket.set(key, value);
+      await bucket.put(key, value);
       const content = await fs.readFile(`/base/path/${key}`, 'utf-8');
 
       expect(content).to.equal(value);
@@ -99,7 +99,7 @@ describe('LocalBucket', () => {
       const bucket = new LocalBucket('/base/path');
 
       try {
-        await bucket.set('', 'value');
+        await bucket.put('', 'value');
         expect.fail('Expected an error to be thrown');
       } catch (error) {
         expect(error.message).to.equal('key is empty');

test/s3.spec.ts

@@ -191,7 +191,7 @@ describe('S3Bucket', () => {
     });
 
     it('should put an object with the specified key and value', async () => {
-      await bucket.set('file1.txt', 'content 1');
+      await bucket.put('file1.txt', 'content 1');
 
       expect(s3Client.putObject.calledOnce).to.be.true;
       expect(s3Client.putObject.firstCall.args[0]).to.deep.equal({
@@ -203,7 +203,7 @@ describe('S3Bucket', () => {
 
     describe('with prefix', () => {
       it('should put an object with the specified key and value', async () => {
-        await bucketSub.set('file1.txt', 'content 1');
+        await bucketSub.put('file1.txt', 'content 1');
 
         expect(s3Client.putObject.calledOnce).to.be.true;
         expect(s3Client.putObject.firstCall.args[0]).to.deep.equal({