docs: silence strictUnionHelper from docs

andnp · Jan 9, 2019 · ccf97e0 · ccf97e0
1 parent f5c6a6f
commit ccf97e0
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ npm install --save-dev simplytyped
 
 **[Objects](#objects)**
 
-[_StrictUnionHelper](#_strictunionhelper) - [AllKeys](#allkeys) - [AllRequired](#allrequired) - [CombineObjects](#combineobjects) - [DeepPartial](#deeppartial) - [DeepReadonly](#deepreadonly) - [DiffKeys](#diffkeys) - [GetKey](#getkey) - [HasKey](#haskey) - [Intersect](#intersect) - [Keys](#keys) - [KeysByType](#keysbytype) - [Merge](#merge) - [ObjectKeys](#objectkeys) - [ObjectType](#objecttype) - [Omit](#omit) - [Optional](#optional) - [Overwrite](#overwrite) - [PlainObject](#plainobject) - [PureKeys](#purekeys) - [Required](#required) - [SharedKeys](#sharedkeys) - [StrictUnion](#strictunion) - [StringKeys](#stringkeys) - [TaggedObject](#taggedobject) - [UnionizeProperties](#unionizeproperties) - [UnionKeys](#unionkeys)
+[AllKeys](#allkeys) - [AllRequired](#allrequired) - [CombineObjects](#combineobjects) - [DeepPartial](#deeppartial) - [DeepReadonly](#deepreadonly) - [DiffKeys](#diffkeys) - [GetKey](#getkey) - [HasKey](#haskey) - [Intersect](#intersect) - [Keys](#keys) - [KeysByType](#keysbytype) - [Merge](#merge) - [ObjectKeys](#objectkeys) - [ObjectType](#objecttype) - [Omit](#omit) - [Optional](#optional) - [Overwrite](#overwrite) - [PlainObject](#plainobject) - [PureKeys](#purekeys) - [Required](#required) - [SharedKeys](#sharedkeys) - [StrictUnion](#strictunion) - [StringKeys](#stringkeys) - [TaggedObject](#taggedobject) - [UnionizeProperties](#unionizeproperties) - [UnionKeys](#unionkeys)
 
 **[Utils](#utils)**
 
@@ -53,10 +53,6 @@ npm install --save-dev simplytyped
 
 ## Objects
 
-### _StrictUnionHelper
-
-
-
 ### AllKeys
 Gets all keys between two objects.
 ```ts

diff --git a/src/types/objects.ts b/src/types/objects.ts
@@ -259,6 +259,7 @@ export type StrictUnion<T> = _StrictUnionHelper<T, T>;
 
 // UnionMember is actually passed as the whole union, but it's used in a distributive conditional
 //   to refer to each individual member of the union
+/** no-doc */
 export type _StrictUnionHelper<UnionMember, Union> =
     UnionMember extends any ?
         UnionMember & Partial<Record<Exclude<UnionKeys<Union>, keyof UnionMember>, never>>