@mangos/filepath 1.0.1 → 1.0.2
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.
- package/README.md +4 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -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 <
|
|
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
|
|
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: <
|
|
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: <
|
|
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>
|