defaultExt and defaultPart options has need renamed to ext and part

Author: dex4er

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v1.1.0 2018-09-07
+
+* The `defaultExt` and `defaultPart` options has need renamed to `ext` and
+  `part`.
+
 ## v1.0.0 2018-09-07
 
 * Rewritten in Typescript.

README.md

@@ -63,8 +63,8 @@ const storage = new FsBlobStorage(options)
 
 _Options:_
 
-* `defaultExt` is a default `ext` argument for methods (optional, default: `''`)
-* `defaultPart` is a default `part` argument for methods (optional, default:
+* `ext` is a default `ext` argument for methods (optional, default: `''`)
+* `part` is a default `part` argument for methods (optional, default:
   `'.part'`)
 * `exclusive` if is true then can't create new object if already exists with
   the same key (optional, default: `false`)
@@ -76,7 +76,7 @@ _Example:_
 
 ```js
 const storage = new FsBlobStorage({
-  defaultPart: '.lock',
+  part: '.lock',
   path: '/var/spool/mail',
   exclusive: true
 })
@@ -91,9 +91,9 @@ const writable = await storage.createWriteStream(key, options)
 _Options:_
 
 * `ext` is a default extension added to file name for the object (optional,
-   default: `this.defaultExt`)
+   default: `this.ext`)
 * `part` is a extension added to file name which can be later commited
-   (optional, default: `this.defaultPart`)
+   (optional, default: `this.part`)
 * `encoding` is a encoding for created file (optional, default: `null`)
 
 Creates a writable stream for a new object in the storage. Object is stored with
@@ -124,9 +124,9 @@ await storage.commit(key, options)
 _Options:_
 
 * `ext` is a default extension added to file name for the object (optional,
-   default: `this.defaultExt`)
+   default: `this.ext`)
 * `part` is a extension added to file name which can be later commited
-   (optional, default: `this.defaultPart`)
+   (optional, default: `this.part`)
 
 Commits the object in the storage. It means that file name for the object is
 renamed and the additional extension for partial objects is removed. Throws an
@@ -141,7 +141,7 @@ await storage.remove(key, options)
 _Options:_
 
 * `ext` is a default extension added to file name for the object (optional,
-   default: `this.defaultExt`)
+   default: `this.ext`)
 
 Removes the object from the storage. Throws an error if has occurred or the
 object doesn't exist.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fs-blob-storage",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Blob storage on filesystem, with streams and promises API",
   "main": "lib/fs-blob-storage.js",
   "typings": "lib/fs-blob-storage.d.ts",

src/fs-blob-storage.ts

@@ -9,8 +9,8 @@ import util from 'util'
 const promisify = require('util.promisify') as typeof util.promisify
 
 export interface FsBlobStorageOptions {
-  defaultExt?: string
-  defaultPart?: string
+  ext?: string
+  part?: string
   exclusive?: boolean
   path?: string
   fs?: typeof fs
@@ -48,17 +48,17 @@ const DEFAULT_EXT = ''
 const DEFAULT_PART = '.part'
 
 export class FsBlobStorage {
-  protected defaultExt: string
-  protected defaultPart: string
+  protected ext: string
+  protected part: string
   protected writeFlags: string
   protected fs: typeof fs
   protected path: string
 
   protected fsPromises: FsPromises
 
   constructor (options: FsBlobStorageOptions = {}) {
-    this.defaultExt = options.defaultExt !== undefined ? options.defaultExt : DEFAULT_EXT
-    this.defaultPart = options.defaultPart !== undefined ? options.defaultPart : DEFAULT_PART
+    this.ext = options.ext !== undefined ? options.ext : DEFAULT_EXT
+    this.part = options.part !== undefined ? options.part : DEFAULT_PART
     this.writeFlags = options.exclusive ? 'wx' : 'w'
     this.fs = options.fs || fs
     this.path = options.path || '.'
@@ -70,7 +70,7 @@ export class FsBlobStorage {
   }
 
   async createWriteStream (key: string, options: FsBlobStorageWriteStreamOptions = {}): Promise<fs.WriteStream> {
-    const { ext = this.defaultExt, part = this.defaultPart, encoding } = options
+    const { ext = this.ext, part = this.part, encoding } = options
     const filepath = path.join(this.path, key + ext)
     const dirpath = path.dirname(filepath)
 
@@ -95,7 +95,7 @@ export class FsBlobStorage {
   }
 
   async createReadStream (key: string, options: FsBlobStorageReadStreamOptions = {}): Promise<fs.ReadStream> {
-    const { ext = this.defaultExt, encoding } = options
+    const { ext = this.ext, encoding } = options
     const filepath = path.join(this.path, key + ext)
 
     const fd = await this.fsPromises.open(filepath, 'r')
@@ -110,15 +110,15 @@ export class FsBlobStorage {
   }
 
   async commit (key: string, options: FsBlobStorageCommitOptions = {}): Promise<void> {
-    const { ext = this.defaultExt, part = this.defaultPart } = options
+    const { ext = this.ext, part = this.part } = options
     if (part) {
       const filepath = path.join(this.path, key + ext)
       return this.fsPromises.rename(filepath + part, filepath)
     }
   }
 
   async remove (key: string, options: FsBlobStorageRemoveOptions = {}): Promise<void> {
-    const { ext = this.defaultExt } = options
+    const { ext = this.ext } = options
     const filepath = path.join(this.path, key + ext)
     return this.fsPromises.unlink(filepath)
   }

test/fs-blob-storage-with-default-ext.ts

@@ -12,7 +12,7 @@ import mockFs from './lib/mock-fs'
 
 const STORAGEDIR = '/tmp/storage'
 
-Feature('Test FsBlobStorage with defaultExt option', () => {
+Feature('Test FsBlobStorage with ext option', () => {
   const fakeFilesystem = {
     [STORAGEDIR]: {
       'commit.txt.part': 'another file content here',
@@ -33,7 +33,7 @@ Feature('Test FsBlobStorage with defaultExt option', () => {
     })
 
     Given('FsBlobStorage object', () => {
-      storage = new FsBlobStorage({ path: STORAGEDIR, defaultExt: '.txt', fs: mockFs })
+      storage = new FsBlobStorage({ path: STORAGEDIR, ext: '.txt', fs: mockFs })
     })
 
     When('key test is passed in', async () => {
@@ -70,7 +70,7 @@ Feature('Test FsBlobStorage with defaultExt option', () => {
     })
 
     Given('FsBlobStorage object', () => {
-      storage = new FsBlobStorage({ path: STORAGEDIR, defaultExt: '.txt', fs: mockFs })
+      storage = new FsBlobStorage({ path: STORAGEDIR, ext: '.txt', fs: mockFs })
     })
 
     When('key test is passed in', async () => {
@@ -98,7 +98,7 @@ Feature('Test FsBlobStorage with defaultExt option', () => {
     })
 
     Given('FsBlobStorage object', () => {
-      storage = new FsBlobStorage({ path: STORAGEDIR, defaultExt: '.txt', fs: mockFs })
+      storage = new FsBlobStorage({ path: STORAGEDIR, ext: '.txt', fs: mockFs })
     })
 
     When('key rs is passed in', async () => {
@@ -121,7 +121,7 @@ Feature('Test FsBlobStorage with defaultExt option', () => {
     })
 
     Given('FsBlobStorage object', () => {
-      storage = new FsBlobStorage({ path: STORAGEDIR, defaultExt: '.txt', fs: mockFs })
+      storage = new FsBlobStorage({ path: STORAGEDIR, ext: '.txt', fs: mockFs })
     })
 
     When('key remove is passed in', async () => {

test/fs-blob-storage-with-default-part.ts

@@ -12,7 +12,7 @@ import mockFs from './lib/mock-fs'
 
 const STORAGEDIR = '/tmp/storage'
 
-Feature('Test FsBlobStorage with defaultPart option', () => {
+Feature('Test FsBlobStorage with part option', () => {
   const fakeFilesystem = {
     [STORAGEDIR]: {
       'commit.txt.lock': 'another file content here',
@@ -33,7 +33,7 @@ Feature('Test FsBlobStorage with defaultPart option', () => {
     })
 
     Given('FsBlobStorage object', () => {
-      storage = new FsBlobStorage({ path: STORAGEDIR, defaultPart: '.lock', fs: mockFs })
+      storage = new FsBlobStorage({ path: STORAGEDIR, part: '.lock', fs: mockFs })
     })
 
     When('key test is passed in', async () => {
@@ -98,7 +98,7 @@ Feature('Test FsBlobStorage with defaultPart option', () => {
     })
 
     Given('FsBlobStorage object', () => {
-      storage = new FsBlobStorage({ path: STORAGEDIR, defaultPart: '.lock', fs: mockFs })
+      storage = new FsBlobStorage({ path: STORAGEDIR, part: '.lock', fs: mockFs })
     })
 
     When('key rs is passed in', async () => {