@mangos/filepath 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -7
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -65,7 +65,7 @@ Most of the time you will be using <a href="#fn-resolve"><code>resolve</code></a
65
65
 
66
66
  <h3 id="infer-path-options">Type <code>InferPathOptions</code></h3>
67
67
 
68
- The functions <a href="fn-all-path"><code>allPath</code></a> and <a href="fn-first-path"><code>firstPath</code></a> will try to tokenize a path string based on options object specified as the second argument.
68
+ The functions <a href="#fn-all-path"><code>allPath</code></a> and <a href="#fn-first-path"><code>firstPath</code></a> will try to tokenize a path string based on options object specified as the second argument.
69
69
 
70
70
  ```typescript
71
71
  type InferPathOptions = {
@@ -82,7 +82,7 @@ The response of <a href="#fn-all-path"><code>allPath</code></a> will be an <b>ar
82
82
 
83
83
  <h4 id="infer-path-options-defaults">defaults:</h4>
84
84
 
85
- If <code><a href="#infer-path-options">InferpathOptions</a></code> argument is left empty in <a href="#fn-all-path"><code>allPath</code></a> and <a href="#fn-first-path"><code>firstPath</code></a> the default will be used based on OS:
85
+ If <a href="#infer-path-options"><code>InferpathOptions</code></a> argument is left empty in <a href="#fn-all-path"><code>allPath</code></a> and <a href="#fn-first-path"><code>firstPath</code></a> the default will be used based on OS:
86
86
 
87
87
 
88
88
  - The default for windos: <code>{ dos: true, devicePath: true, unc: true, posix: false }</code>
@@ -132,7 +132,7 @@ function allPath(path = '', options: InferPathOptions = {}): (ParsedPath | Parse
132
132
  <h5 id="fn-all-path-arguments">Arguments:</h5>
133
133
 
134
134
  - <code>path: <i>string</i> optional</code>: (<b>Default</b> is current working directory). Relative or absolute <code>path</code> conforming to one of the <a href="#supported-path">supported path types</a>.
135
- - <code>options: <i><a href="#infer-path-options">InferPathOptions</a></i> optional</code>: Parsing limited to flags set to <code>true</code> in <a href="#infer-path-options">options</a>.
135
+ - <code>options: <i>InferPathOptions</i> optional</code>: Parsing limited to flags set to <code>true</code> in <a href="#infer-path-options">options</a>.
136
136
 
137
137
  <h5 id="fn-all-path-return">Return:</h5>
138
138
 
@@ -166,14 +166,13 @@ function firstPath(path = '', options: InferPathOptions = {}): ParsedPath | Pars
166
166
  <h5 id="fn-first-path-arguments">Arguments:</h5>
167
167
 
168
168
  - <code>path: <i>string</i> optional</code>: (<b>Default</b> is current working directory). Relative or absolute <code>path</code> conforming to one of the <a href="#supported-path">supported path types</a>.
169
- - <code>options: <a href="infer-path-options">InferPathOptions</a> optional</code>: Parsing limited to flags set to <code>true</code> in <a href="#infer-path-options">options</a>.
169
+ - <code>options: <i>InferPathOptions</i> optional</code>: Parsing limited to flags set to <code>true</code> in <a href="#infer-path-options">options</a>.
170
170
 
171
171
  <h5 id="fn-all-path-return">Return:</h5>
172
172
 
173
173
  - <code>undefined</code>: The path was not confirm to any of the types listed in <a href="#supported-path">path types</a>
174
174
 
175
175
  - <a href="#parsed-path"><code>ParsedPath</code></a>: In case of successfull parse.
176
-
177
176
  - <a href="#parsed-path-error"><code>ParsedPathError</code></a>: In case of legal structure but illegal characters in the path.
178
177
 
179
178
 
@@ -185,7 +184,7 @@ function resolvePathObject(from: ParsedPath, ...toFragments: string[]): ParsedPa
185
184
 
186
185
  <h5 id="fn-resolve-path-object-arguments">Arguments:</h5>
187
186
 
188
- - <code>from: <a href="#parsed-path">ParsedPath</a></code>: A previously created <code><a href="#parsed-path">ParsedPath</a></code> object via <code><a href="#fn-first-path">firstPath</a></code> function.
187
+ - <code>from: <i>ParsedPath</i></code>: A previously created <code><a href="#parsed-path">ParsedPath</a></code> object via <a href="#fn-first-path"><code>firstPath</code></a> function.
189
188
  - <code>toFragments: <i>string[]</i></code>: A sequence of paths or path segments.
190
189
 
191
190
  <h5 id="fn-resolve-path-object-return">Return:</h5>
@@ -205,7 +204,7 @@ function resolve(fromStr: string, ...toFragments: string[]): ParsedPath | Parsed
205
204
 
206
205
  <h5 id="fn-resolve-arguments">Arguments:</h5>
207
206
 
208
- - <code>fromStr: <i>string</i> optional</code>: A path according to a <a href="#supperted-path">path type</a>. Defaults to current working directory if absent/undefined.
207
+ - <code>fromStr: <i>string</i> optional</code>: A path according to a <a href="#supported-path">path type</a>. Defaults to current working directory if absent/undefined.
209
208
  - <code>toFragments: <i>string[]</i></code>: A sequence of paths or path segments.
210
209
 
211
210
  <h5 id="fn-resolve-return">Return:</h5>
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@mangos/filepath",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "author": "jacob bogers <jkfbogers@gmail.com>",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "https://github.com/R-js/mangos.git",
7
+ "url": "git+https://github.com/R-js/mangos.git",
8
8
  "directory": "packages/filepath"
9
9
  },
10
10
  "exports": {