@mangos/filepath 1.0.6 → 1.0.8

package/README.md

@@ -64,7 +64,19 @@ import { allPath, firstPath, resolve, resolvePathObject } from '@mangos/filepath
 There are 2 exported classes:
 
 ```typescript
-import { ParsedPath,  ParsedPathError } from '@mangos/filepath';
+import { ParsedPath,  ParsedPathError, PathToken } from '@mangos/filepath';
+```
+
+There is 1 exported enum:
+
+```typescript
+import { PathTokenEnum } from '@mangos/filepath'
+```
+
+There is 1 exported type:
+
+```typescript
+import type { InferPathOptions } from '@mangos/filepath'
 ```
 
 Most of the time you will be using <a href="#fn-resolve"><code>resolve</code></a>, <a href="#fn-first-path"><code>firstPath</code></a>.
@@ -127,6 +139,37 @@ When a string is parsed it will be evaluated according to path types in the foll
 3. `dos` tokanization will be tried third, (if the `dos` boolean is set to true).
 4. `posix` tokanization will be tried forth, (if the `posix` boolean is set to true)
 
+<h3 id="path-token-type"><code>PathToken</code> object</h3>
+
+You dont create `PathToken`s yourself the api will do it for you.
+
+```typescript
+class PathToken {
+    token: PathTokenValueType;
+	value: string; // actual path fragment (directory, seperator, or file)
+	start: number; // start location in the original string
+	end: number; // end (inclusive) in the original string
+    error?: string; // this token has invalid character for the OS selected
+    isRoot(): boolean; // is this token a Root Token (c:/,  /, //?/UNC/Server/share, etc)
+    isPathElement(): boolean; // a normal path element
+    isCurrent(): boolean; // token representing "./"
+    isParent(): boolean // token representing "../"
+    isSeperator(): boolean // token representing "/" (posix) or "\" (windows, dos)
+}
+```
+
+The `PathTokenValueType` match the exported `PathTokenEnum` object
+
+```typescript
+export const PathTokenEnum = {
+	SEP: '\x01',       // path seperator
+	ROOT: '\x03',      // the root (if it is an absolute path)
+	PATHELT: '\x06',   // directory, file, 
+	PARENT: '\x07',    // two dots (..) meaning parent directory
+	CURRENT: '\x08',   // a single dot (.) meaning current directory
+} as const;
+```
+
 <h3 id="api-functions">Functions</h3>
 
 <h4 id="fn-all-path">function: <code>allPath</code></h4>

package/dist/Token.d.ts

@@ -14,5 +14,9 @@ export declare class PathToken {
     readonly error?: string;
     constructor(token: PathTokenValueType, value: string, start: number, end: number, error?: string);
     isRoot(): boolean;
+    isSeparator(): boolean;
+    isPathElement(): boolean;
+    isCurrent(): boolean;
+    isParent(): boolean;
     equals(ot: PathToken): boolean;
 }

package/dist/Token.js

@@ -16,6 +16,18 @@ class PathToken {
   isRoot() {
     return this.token === PathTokenEnum.ROOT;
   }
+  isSeparator() {
+    return this.token === PathTokenEnum.SEP;
+  }
+  isPathElement() {
+    return this.token === PathTokenEnum.PATHELT;
+  }
+  isCurrent() {
+    return this.token === PathTokenEnum.CURRENT;
+  }
+  isParent() {
+    return this.token === PathTokenEnum.PARENT;
+  }
   equals(ot) {
     return ot.token === this.token && ot.value === this.value && ot.error === this.error;
   }

package/dist/index.d.ts

@@ -1,7 +1,8 @@
+import { PathTokenEnum } from './constants.js';
 import { ParsedPath } from './ParsedPath.js';
 import { ParsedPathError } from './ParsedPathError.js';
 import { allPath, firstPath, resolve, resolvePathObject } from './parser.js';
-import type { PathToken } from './Token.js';
+import { PathToken } from './Token.js';
 import type { PathTokenValueType } from './types/TokenValueType.js';
-export { resolve, firstPath, allPath, ParsedPath, ParsedPathError, resolvePathObject };
-export type { PathTokenValueType, PathToken };
+export { resolve, firstPath, allPath, ParsedPath, ParsedPathError, PathToken, resolvePathObject, PathTokenEnum };
+export type { PathTokenValueType };

package/dist/index.js

@@ -1,9 +1,13 @@
+import { PathTokenEnum } from "./constants.js";
 import { ParsedPath } from "./ParsedPath.js";
 import { ParsedPathError } from "./ParsedPathError.js";
 import { allPath, firstPath, resolve, resolvePathObject } from "./parser.js";
+import { PathToken } from "./Token.js";
 export {
   ParsedPath,
   ParsedPathError,
+  PathToken,
+  PathTokenEnum,
   allPath,
   firstPath,
   resolve,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@mangos/filepath",
-	"version": "1.0.6",
+	"version": "1.0.8",
 	"author": "jacob bogers <jkfbogers@gmail.com>",
 	"repository": {
 		"type": "git",