0.0.20

add `file()` method

Author: ewilan-riviere

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kiwilan/filesystem",
   "type": "module",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "Node module to improve native filesystem with Laravel like helpers.",
   "author": "Ewilan Rivière <[email protected]>",
   "license": "MIT",

src/lib/FsFile.ts

@@ -297,6 +297,16 @@ export class FsFile {
     return await glob(pattern, options)
   }
 
+  /**
+   * Get an `FsFileItem` instance for the given path.
+   */
+  public static async file(path: string): Promise<FsFileItem> {
+    if (!await this.exists(path))
+      throw new Error(`File does not exist at path ${path}`)
+
+    return await FsFileItem.makeFromPath(path)
+  }
+
   /**
    * Get an array of all files in a directory.
    */

tests/file.test.ts

@@ -21,3 +21,21 @@ it('can get file sync', () => {
 
   expect(content).toContain('Test')
 })
+
+it('can get file sync', async () => {
+  const path = FsPath.root('tests/test.md')
+  const fsItem = await FsFile.file(path)
+
+  expect(fsItem.name).toBe('test')
+  expect(fsItem.filename).toBe('test.md')
+  expect(fsItem.path.includes('node-filesystem/tests/test.md')).toBe(true)
+  expect(fsItem.pathRelative).toBe('tests/test.md')
+  expect(fsItem.extension).toBe('md')
+  expect(fsItem.isDirectory).toBe(false)
+  expect(fsItem.isFile).toBe(true)
+  expect(fsItem.isSymbolicLink).toBe(false)
+  expect(fsItem.isHidden).toBe(false)
+  expect(fsItem.lastModified).toBeGreaterThan(0)
+  expect(fsItem.size).toBe(29)
+  expect(fsItem.sizeHuman).toBe('29 B')
+})