Improve exports + API extraction

SchoofsKelvin · Jul 9, 2021 · a3a9e56 · a3a9e56
1 parent c9e2202
commit a3a9e56
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 1 deletion.
diff --git a/api-extractor.json b/api-extractor.json
@@ -18,6 +18,10 @@
     "extractorMessageReporting": {
       "ae-missing-release-tag": {
         "logLevel": "none"
+      },
+      "ae-internal-missing-underscore": {
+        "logLevel": "none",
+        "addToApiReportFile": false
       }
     }
   },

diff --git a/api/ip-matching.api.md b/api/ip-matching.api.md
@@ -157,5 +157,8 @@ export class IPv6 extends IPMatch {
 // @public
 export function matches(ip: string | IP, target: string | IPMatch): boolean;
 
+// @internal (undocumented)
+export function partsToIP(parts: number[]): IP;
+
 
 ```
diff --git a/api/untrimmed.d.ts b/api/untrimmed.d.ts
@@ -277,4 +277,7 @@ export declare class IPv6 extends IPMatch {
  */
 export declare function matches(ip: string | IP, target: string | IPMatch): boolean;
 
+/** @internal */
+export declare function partsToIP(parts: number[]): IP;
+
 export { }
diff --git a/src/index.ts b/src/index.ts
@@ -7,7 +7,7 @@
 
 import { getMatch, IP, IPMatch } from './ip';
 
-export { getIP, getMatch, IP, IPMask, IPMatch, IPRange, IPSubnetwork, IPv4, IPv6 } from './ip';
+export * from './ip';
 
 /**
  * Checks whether the given IP matches the given whitelist

diff --git a/src/ip.ts b/src/ip.ts
@@ -474,6 +474,7 @@ export function getIP(input: string | IP): IP | null {
   return null;
 }
 
+/** @internal */
 export function partsToIP(parts: number[]): IP {
   if (parts.length !== 4 && parts.length !== 8)
     throw new Error(`Expected 4 or 8 parts, got ${parts.length} instead`);