namefully 1.2.0 → 1.2.1

package/dist/{lib → types}/namefully.d.ts

@@ -47,14 +47,7 @@ import { Flat, NameOrder, NameType, Namon, Nullable, Surname } from './types';
  * Happy name handling 😊!
  */
 export declare class Namefully {
-    /**
-     * A copy of high-quality name data.
-     */
-    private _fullName;
-    /**
-     * A copy of the default configuration (combined with a custom one if any).
-     */
-    private _config;
+    #private;
     /**
      * Creates a name with distinguishable parts from a raw string content.
      * @param names element to parse.
@@ -88,77 +81,41 @@ export declare class Namefully {
      * process.
      */
     static parse(text: string): Promise<Namefully>;
-    /**
-     * The current configuration.
-     */
+    /** The current configuration. */
     get config(): Config;
-    /**
-     * The number of characters of the `birthName`, including spaces.
-     */
+    /** The number of characters of the `birthName`, including spaces. */
     get length(): number;
-    /**
-     * The prefix part.
-     */
+    /** The prefix part. */
     get prefix(): Nullable<string>;
-    /**
-     * The firt name.
-     */
+    /** The firt name part. */
     get first(): string;
-    /**
-     * The first middle name if any.
-     */
+    /** The first middle name part if any. */
     get middle(): Nullable<string>;
-    /**
-     * Returns true if any middle name has been set.
-     */
+    /** Returns true if any middle name has been set. */
     get hasMiddle(): boolean;
-    /**
-     * The last name.
-     */
+    /** The last name part. */
     get last(): string;
-    /**
-     * The suffix part.
-     */
+    /** The suffix part. */
     get suffix(): Nullable<string>;
-    /**
-     * The birth name.
-     */
+    /** The birth name part. */
     get birth(): string;
-    /**
-     * The shortest version of a person name.
-     */
+    /** The shortest version of a person name. */
     get short(): string;
-    /**
-     * The longest version of a person name.
-     */
+    /** The longest version of a person name. */
     get long(): string;
-    /**
-     * The entire name set.
-     */
+    /** The entire name set. */
     get full(): string;
-    /**
-     * The first name combined with the last name's initial.
-     */
+    /** The first name combined with the last name's initial. */
     get public(): string;
-    /**
-     * Returns the full name as set.
-     */
+    /** Returns the full name as set. */
     toString(): string;
-    /**
-     * Fetches the raw form of a name piece.
-     */
+    /** Fetches the raw form of a name piece. */
     get(namon: Namon): Nullable<Name | Name[]>;
-    /**
-     * Whether this name is equal to another one from a raw-string perspective.
-     */
+    /** Whether this name is equal to another one from a raw-string perspective. */
     equal(other: Namefully): boolean;
-    /**
-     * Gets a JSON representation of the full name.
-     */
+    /** Gets a JSON representation of the full name. */
     toJson(): JsonName;
-    /**
-     * Confirms that a name part has been set.
-     */
+    /** Confirms that a name part has been set. */
     has(namon: Namon): boolean;
     /**
      * Gets the full name ordered as configured.
@@ -191,9 +148,7 @@ export declare class Namefully {
      * name.
      */
     firstName(withMore?: boolean): string;
-    /**
-     * Gets the middle name part of the `FullName`.
-     */
+    /** Gets the middle name part of the `FullName`. */
     middleName(): string[];
     /**
      * Gets the last name part of the `FullName`.
@@ -327,9 +282,7 @@ export declare class Namefully {
      * first, middle, and last names.
      */
     format(pattern: string): string;
-    /**
-     * Flips definitely the name order from the preset/current config.
-     */
+    /** Flips definitely the name order from the preset/current config. */
     flip(): void;
     /**
      * Splits the name parts of a birth name.
@@ -341,39 +294,20 @@ export declare class Namefully {
      * @param separator token for the junction.
      */
     join(separator?: string): string;
-    /**
-     * Transforms a birth name into UPPERCASE
-     */
+    /** Transforms a birth name into UPPERCASE. */
     toUpperCase(): string;
-    /**
-     * Transforms a birth name into lowercase
-     */
+    /** Transforms a birth name into lowercase. */
     toLowerCase(): string;
-    /**
-     * Transforms a birth name into camelCase
-     */
+    /** Transforms a birth name into camelCase. */
     toCamelCase(): string;
-    /**
-     * Transforms a birth name into PascalCase
-     */
+    /** Transforms a birth name into PascalCase. */
     toPascalCase(): string;
-    /**
-     * Transforms a birth name into snake_case
-     */
+    /** Transforms a birth name into snake_case. */
     toSnakeCase(): string;
-    /**
-     * Transforms a birth name into hyphen-case
-     */
+    /** Transforms a birth name into hyphen-case. */
     toHyphenCase(): string;
-    /**
-     * Transforms a birth name into dot.case
-     */
+    /** Transforms a birth name into dot.case. */
     toDotCase(): string;
-    /**
-     * Transforms a birth name into ToGgLeCaSe
-     */
+    /** Transforms a birth name into ToGgLeCaSe. */
     toToggleCase(): string;
-    private build;
-    private toParser;
-    private map;
 }

package/dist/{lib → types}/parser.d.ts

@@ -27,20 +27,15 @@ export declare abstract class Parser<T = any> {
     abstract parse(options?: Partial<Config>): FullName;
 }
 export declare class StringParser extends Parser<string> {
-    constructor(raw: string);
     parse(options: Partial<Config>): FullName;
 }
 export declare class ArrayStringParser extends Parser<string[]> {
-    constructor(raw: string[]);
     parse(options: Partial<Config>): FullName;
-    private split;
 }
 export declare class NamaParser extends Parser<JsonName> {
-    constructor(raw: JsonName);
+    #private;
     parse(options: Partial<Config>): FullName;
-    private asNama;
 }
 export declare class ArrayNameParser extends Parser<Name[]> {
-    constructor(raw: Name[]);
     parse(options: Partial<Config>): FullName;
 }

package/dist/{lib/src → types}/types.d.ts

@@ -1,7 +1,7 @@
 /**
  * Make a type nullable.
  */
-export declare type Nullable<T> = T | null | undefined;
+export type Nullable<T> = T | null | undefined;
 /**
  * The abbreviation type to indicate whether or not to add period to a prefix
  * using the American or British way.

package/dist/{lib → types}/utils.d.ts

@@ -28,18 +28,12 @@ export declare class NameIndex {
     readonly middleName: number;
     readonly lastName: number;
     readonly suffix: number;
-    /**
-     * The minimum number of parts in a list of names.
-     */
+    /** The minimum number of parts in a list of names. */
     static get min(): number;
-    /**
-     * The maximum number of parts in a list of names.
-     */
+    /** The maximum number of parts in a list of names. */
     static get max(): number;
     private constructor();
-    /**
-     * The default or base indexing: firstName lastName.
-     */
+    /** The default or base indexing: firstName lastName. */
     static base(): NameIndex;
     /**
      * Gets the name index for a list of names based on the `count` of elements
@@ -51,13 +45,9 @@ export declare class NameIndex {
  * Capitalizes a string via a `CapsRange` option.
  */
 export declare function capitalize(str: string, range?: CapsRange): string;
-/**
- * Decapitalizes a string via a `CapsRange` option.
- */
+/** Decapitalizes a string via a `CapsRange` option. */
 export declare function decapitalize(str: string, range?: CapsRange): string;
-/**
- * Toggles a string representation.
- */
+/** 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;

package/dist/{lib → types}/validator.d.ts

@@ -8,32 +8,27 @@ declare class ArrayValidator<T extends string | Name> implements Validator<T[]>
     validate(values: T[]): void;
 }
 declare class NamonValidator implements Validator<string | Name> {
-    private static validator;
-    private constructor();
+    #private;
     static create(): NamonValidator;
     validate(value: string | Name, type?: Namon): void;
 }
 declare class FirstNameValidator implements Validator<string | FirstName> {
-    private static validator;
-    private constructor();
+    #private;
     static create(): FirstNameValidator;
     validate(value: string | FirstName): void;
 }
 declare class MiddleNameValidator implements Validator<string | string[] | Name[]> {
-    private static validator;
-    private constructor();
+    #private;
     static create(): MiddleNameValidator;
     validate(value: string | string[] | Name[]): void;
 }
 declare class LastNameValidator implements Validator<string | LastName> {
-    private static validator;
-    private constructor();
+    #private;
     static create(): LastNameValidator;
     validate(value: string | LastName): void;
 }
 export declare class NamaValidator implements Validator<Map<Namon, string>> {
-    private static validator;
-    private constructor();
+    #private;
     static create(): NamaValidator;
     validate(value: Map<Namon, string>): void;
     validateKeys(nama: Map<Namon, string>): void;
@@ -45,15 +40,11 @@ export declare class ArrayStringValidator extends ArrayValidator<string> {
     validateIndex(values: string[]): void;
 }
 export declare class ArrayNameValidator implements Validator<Name[]> {
-    private static validator;
-    private constructor();
+    #private;
     static create(): ArrayNameValidator;
     validate(value: Name[]): void;
-    private hasBasicNames;
 }
-/**
- * A list of validators for a specific namon.
- */
+/** A list of validators for a specific namon. */
 export declare abstract class Validators {
     static namon: NamonValidator;
     static nama: NamaValidator;