namefully 1.3.0 → 1.3.1

package/dist/types/types.d.ts

@@ -1,6 +1,4 @@
-/**
- * Make a type nullable.
- */
+/** Make a type nullable. */
 export type Nullable<T> = T | null | undefined;
 /**
  * The abbreviation type to indicate whether or not to add period to a prefix
@@ -23,25 +21,19 @@ export declare enum Surname {
     HYPHENATED = "hyphenated",
     ALL = "all"
 }
-/**
- * The order of appearance of a `FullName`.
- */
+/** The order of appearance of a `FullName`. */
 export declare enum NameOrder {
     FIRST_NAME = "firstName",
     LAST_NAME = "lastName"
 }
-/**
- * The types of name handled in this according the name standards.
- */
+/** The types of name handled in this according the name standards. */
 export declare enum NameType {
     FIRST_NAME = "firstName",
     MIDDLE_NAME = "middleName",
     LAST_NAME = "lastName",
     BIRTH_NAME = "birthName"
 }
-/**
- * The possible variants to indicate how to flatten a `FullName`.
- */
+/** The possible variants to indicate how to flatten a `FullName`. */
 export declare enum Flat {
     FIRST_NAME = "firstName",
     MIDDLE_NAME = "middleName",
@@ -50,17 +42,13 @@ export declare enum Flat {
     MID_LAST = "midLast",
     ALL = "all"
 }
-/**
- * The range to use when capitalizing a string content.
- */
+/** The range to use when capitalizing a string content. */
 export declare enum CapsRange {
     NONE = 0,
     INITIAL = 1,
     ALL = 2
 }
-/**
- * The types of name handled in this utility according the name standards.
- */
+/** The types of name handled in this utility according the name standards. */
 export declare class Namon {
     readonly index: number;
     readonly key: string;
@@ -69,35 +57,22 @@ export declare class Namon {
     static readonly MIDDLE_NAME: Namon;
     static readonly LAST_NAME: Namon;
     static readonly SUFFIX: Namon;
-    /**
-     * The list of supported name types.
-     */
+    /** The list of supported name types. */
     static readonly values: Namon[];
-    /**
-     * All the predefined name types.
-     */
+    /** All the predefined name types. */
     static readonly all: Map<string, Namon>;
+    private static readonly aliases;
     private constructor();
-    /**
-     * Whether this string key is part of the predefined keys.
-     */
+    /** Whether this string key is part of the predefined keys. */
     static has(key: string): boolean;
-    /**
-     * Makes a string key a namon type.
-     */
+    /** Makes a string key a namon type. */
     static cast(key: string): Nullable<Namon>;
-    /**
-     * String representation of this object.
-     */
+    /** String representation of this object. */
     toString(): string;
-    /**
-     * Whether this and the other value are equal.
-     */
+    /** Whether this and the other value are equal. */
     equal(other: Namon | unknown): boolean;
 }
-/**
- * The token used to indicate how to split string values.
- */
+/** The token used to indicate how to split string values. */
 export declare class Separator {
     readonly name: string;
     readonly token: string;
@@ -111,17 +86,13 @@ export declare class Separator {
     static readonly SINGLE_QUOTE: Separator;
     static readonly SPACE: Separator;
     static readonly UNDERSCORE: Separator;
-    /**
-     * All the available separators.
-     */
+    /** All the available separators. */
     static readonly all: Map<string, Separator>;
-    /**
-     * All the available tokens.
-     */
+    /** All the available tokens. */
     static readonly tokens: string[];
     private constructor();
-    /**
-     * String representation of this object.
-     */
+    /** Makes a string key a separator type. */
+    static cast(key: string): Nullable<Separator>;
+    /** String representation of this object. */
     toString(): string;
 }

package/dist/types/utils.d.ts

@@ -1,6 +1,6 @@
 import { NameOrder, CapsRange } from './types';
 /**
- * A fixed set of values to handle specific positions for list of names.
+ * A set of values to handle specific positions for list of names.
  *
  * As for list of names, this helps to follow a specific order based on the
  * count of elements. It is expected that the list has to be between two and
@@ -42,14 +42,12 @@ export declare class NameIndex {
     static when(order: NameOrder, count?: number): NameIndex;
     static only({ prefix, firstName, middleName, lastName, suffix }: Record<string, number>): NameIndex;
     toJson(): Record<string, number>;
+    json: () => Record<string, number>;
 }
-/**
- * Capitalizes a string via a `CapsRange` option.
- */
+/** Capitalizes a string via a `CapsRange` option. */
 export declare function capitalize(str: string, range?: CapsRange): string;
 /** Decapitalizes a string via a `CapsRange` option. */
 export declare function decapitalize(str: string, range?: CapsRange): string;
 /** Toggles a string representation. */
 export declare function toggleCase(str: string): string;
-export declare function isStringArray(value?: unknown): boolean;
-export declare function isNameArray(value?: unknown): boolean;
+export declare function isStringArray(value?: unknown): value is string[];

package/dist/types/validator.d.ts

@@ -1,6 +1,6 @@
-import { FirstName, LastName, Name } from './name';
 import { Namon } from './types';
 import { NameIndex } from './utils';
+import { FirstName, LastName, Name } from './name';
 export interface Validator<T> {
     validate(value: T): void;
 }