get-tsconfig - npm Package Compare versions

Comparing version 4.8.1 to 4.9.0

package.json

 {
   "name": "get-tsconfig",
-  "version": "4.8.1",
+  "version": "4.9.0",
   "description": "Find and parse the tsconfig.json file from a directory path",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -41,4 +41,5 @@ <p align="center">
 ### getTsconfig(searchPath?, configName?, cache?)
-Searches for a `tsconfig.json` file and parses it. Returns `null` if a config file cannot be found, or an object containing the path and parsed TSConfig object if found.
 
+Searches for a tsconfig file (defaults to `tsconfig.json`) in the `searchPath` and parses it. (If you already know the tsconfig path, use [`parseTsconfig`](#parsetsconfigtsconfigpath-cache) instead). Returns `null` if a config file cannot be found, or an object containing the path and parsed TSConfig object if found.
+
 Returns:
@@ -106,4 +107,5 @@
 ### parseTsconfig(tsconfigPath, cache?)
-The `tsconfig.json` parser used internally by `getTsconfig`. Returns the parsed tsconfig as `TsConfigJsonResolved`.
 
+Parse the tsconfig file provided. Used internally by `getTsconfig`. Returns the parsed tsconfig as `TsConfigJsonResolved`.
+
 #### tsconfigPath
@@ -130,2 +132,4 @@ Type: `string`
 
+---
+
 ### createFileMatcher(tsconfig: TsconfigResult, caseSensitivePaths?: boolean)
@@ -132,0 +136,0 @@

No alert changes

Improved metrics

Total package byte prevSize

110347

increased by4.63%

Number of lines in readme file

236

increased by1.72%

No dependency changes