namefully 1.1.0 → 1.2.1

package/dist/lib/models/firstname.js

@@ -1,131 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * First name class definition
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const index_1 = require("./index");
-const core_1 = require("../core");
-/**
- * Represents a first name with some extra functionalities
- * @class
- * @extends Name
- */
-class Firstname extends index_1.Name {
-    /**
-     * Constructs a `Firstname`
-     * @param {string} namon a piece of string that will be defined as a namon
-     * @param {string[]} [more] additional pieces considered as a given name
-     */
-    constructor(namon, ...more) {
-        super(namon, index_1.Namon.FIRST_NAME);
-        this.namon = namon;
-        this.more = [];
-        this.more = more;
-    }
-    /**
-     * Determines whether a first name has more name parts
-     */
-    hasMore() {
-        return Array.isArray(this.more) && this.more.length > 0;
-    }
-    /**
-     * Gives some descriptive statistics that summarize the central tendency,
-     * dispersion and shape of the characters' distribution.
-     * @param {boolean} includeAll whether to include other pieces of the first
-     * name in the summary
-     * @see {@link describe} in `Namefully` class for further information
-     */
-    describe(includeAll = false) {
-        return new index_1.Summary(this.tostring(includeAll));
-    }
-    /**
-     * Returns a string representation of the first name
-     * @param {boolean} includeAll whether to include other pieces of the first
-     * name
-     */
-    tostring(includeAll = true) {
-        return !includeAll
-            ? this.namon
-            : this.namon.concat(index_1.Separator.SPACE, this.more.join(index_1.Separator.SPACE)).trim();
-    }
-    /**
-     * Gets the initials of the first name
-     */
-    getInitials(includeAll = false) {
-        const initials = [this.namon[0]];
-        if (includeAll && this.hasMore()) {
-            initials.push(...this.more.map(n => n[0]));
-        }
-        return initials;
-    }
-    /**
-     * Capitalizes a first name
-     * @param {'initial' | 'all'} option how to capitalize its subparts
-     */
-    capitalize(option = 'initial') {
-        if (option === 'initial') {
-            this.namon = this.namon[0].toUpperCase().concat(this.namon.slice(1));
-            if (this.hasMore())
-                this.more = this.more.map(n => n[0].toUpperCase().concat(n.slice(1)));
-        }
-        else {
-            this.namon = this.namon.toUpperCase();
-            if (this.hasMore())
-                this.more = this.more.map(n => n.toUpperCase());
-        }
-        return this;
-    }
-    /**
-     * De-capitalizes a first name
-     * @param {'initial' | 'all'} option how to decapitalize its subparts
-     */
-    decapitalize(option = 'initial') {
-        if (option === 'initial') {
-            this.namon = this.namon[0].toLowerCase().concat(this.namon.slice(1));
-            if (this.hasMore())
-                this.more = this.more.map(n => n[0].toLowerCase().concat(n.slice(1)));
-        }
-        else {
-            this.namon = this.namon.toLowerCase();
-            if (this.hasMore())
-                this.more = this.more.map(n => n.toLowerCase());
-        }
-        return this;
-    }
-    /**
-     * Normalizes the first name as it should be
-     */
-    normalize() {
-        this.namon = this.namon[0]
-            .toUpperCase()
-            .concat(this.namon.slice(1).toLowerCase());
-        if (this.hasMore())
-            this.more = this.more.map(n => n[0]
-                .toUpperCase()
-                .concat(n.slice(1).toLowerCase()));
-        return this;
-    }
-    /**
-     * Returns an ascii representation of each characters of a first name
-     * @param restrictions chars to skip
-     */
-    ascii(restrictions) {
-        return core_1.convertToAscii(this.tostring(true), restrictions);
-    }
-    /**
-     * Returns a password-like representation of a first name
-     */
-    passwd() {
-        return core_1.generatePassword(this.tostring(true));
-    }
-}
-exports.Firstname = Firstname;
-Firstname.prototype.cap = Firstname.prototype.capitalize;
-Firstname.prototype.decap = Firstname.prototype.decapitalize;
-Firstname.prototype.norm = Firstname.prototype.normalize;
-Firstname.prototype.stats = Firstname.prototype.describe;
-Firstname.prototype.inits = Firstname.prototype.getInitials;
-//# sourceMappingURL=firstname.js.map

package/dist/lib/models/firstname.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"firstname.js","sourceRoot":"","sources":["../../../src/models/firstname.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,mCAA0D;AAC1D,kCAA2D;AAG3D;;;;GAIG;AACH,MAAa,SAAU,SAAQ,YAAI;IAG/B;;;;OAIG;IACH,YAAmB,KAAa,EAAE,GAAG,IAAc;QAC/C,KAAK,CAAC,KAAK,EAAE,aAAK,CAAC,UAAU,CAAC,CAAC;QADhB,UAAK,GAAL,KAAK,CAAQ;QANhC,SAAI,GAAa,EAAE,CAAC;QAQhB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,OAAO;QACH,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,aAAsB,KAAK;QAChC,OAAO,IAAI,eAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,aAAsB,IAAI;QAC/B,OAAO,CAAC,UAAU;YACd,CAAC,CAAC,IAAI,CAAC,KAAK;YACZ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CACf,iBAAS,CAAC,KAAK,EACf,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAS,CAAC,KAAK,CAAC,CAClC,CAAC,IAAI,EAAE,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,aAAsB,KAAK;QACnC,MAAM,QAAQ,GAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;YAC9B,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC9C;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,SAA4B,SAAS;QAC5C,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACrE,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC7E;aAAM;YACH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YACtC,IAAI,IAAI,CAAC,OAAO,EAAE;gBAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;SACvE;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,SAA4B,SAAS;QAC9C,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACrE,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC7E;aAAM;YACH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YACtC,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;SACvD;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,SAAS;QACL,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;aACrB,WAAW,EAAE;aACb,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAC/C,IAAI,IAAI,CAAC,OAAO,EAAE;YACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CACrB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;iBACJ,WAAW,EAAE;iBACb,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CACxC,CAAC;QACN,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAuB;QACzB,OAAO,qBAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,MAAM;QACF,OAAO,uBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;IAChD,CAAC;CACJ;AAvHD,8BAuHC;AAaD,SAAS,CAAC,SAAS,CAAC,GAAG,GAAG,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC;AACzD,SAAS,CAAC,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC;AAC7D,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC;AACzD,SAAS,CAAC,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC;AACzD,SAAS,CAAC,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC"}

package/dist/lib/models/fullname.d.ts

@@ -1,73 +0,0 @@
-/**
- * Full name builder
- *
- * Created on July 04, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Name, Firstname, Lastname, Prefix, Suffix } from './index';
-import { LastnameFormat } from './misc';
-/**
- * Interface for JSON signature that represents the full name
- * @interface
- */
-export interface Fullname {
-    firstname: Firstname;
-    lastname: Lastname;
-    middlename?: Name[];
-    prefix?: Prefix;
-    suffix?: Suffix;
-}
-/**
- * Uses method chaining to build `Fullname`
- */
-export declare class FullnameBuilder {
-    private bypass;
-    private _px;
-    private _fn;
-    private _mn;
-    private _ln;
-    private _sx;
-    constructor(bypass?: boolean);
-    /**
-     * Builds with prefix
-     * @param namon prefix name part
-     */
-    prefix(namon: string): this;
-    /**
-     * Builds with firstname
-     * @param namon a piece of string that will be defined as a namon
-     * @param more additional pieces considered as a given name
-     */
-    firstname(namon: string, ...more: string[]): this;
-    /**
-     * Builds with middlename
-     * @param nama middle names
-     */
-    middlename(...nama: string[]): this;
-    /**
-     * Builds with lastname
-     * @param father a piece of string that will be defined as a namon
-     * @param mother additional pieces considered as a last name
-     * @param format how to output a surname considering its subparts
-     */
-    lastname(father: string, mother?: string, format?: LastnameFormat): this;
-    /**
-     * Builds with suffix
-     * @param namon suffix name part
-     */
-    suffix(namon: string): this;
-    /**
-     * Builds a `Fulllname`
-     */
-    build(): Fullname;
-}
-/**
- * Aliases for `FullnameBuilder`
- */
-export interface FullnameBuilder {
-    px: typeof FullnameBuilder.prototype.prefix;
-    fn: typeof FullnameBuilder.prototype.firstname;
-    mn: typeof FullnameBuilder.prototype.middlename;
-    ln: typeof FullnameBuilder.prototype.lastname;
-    sx: typeof FullnameBuilder.prototype.suffix;
-}

package/dist/lib/models/fullname.js

@@ -1,99 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Full name builder
- *
- * Created on July 04, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const index_1 = require("./index");
-const validators_1 = require("../validators");
-/**
- * Uses method chaining to build `Fullname`
- */
-class FullnameBuilder {
-    constructor(bypass = false) {
-        this.bypass = bypass;
-        this._px = null;
-        this._fn = null;
-        this._mn = [];
-        this._ln = null;
-        this._sx = null;
-    }
-    /**
-     * Builds with prefix
-     * @param namon prefix name part
-     */
-    prefix(namon) {
-        if (!this.bypass)
-            new validators_1.PrefixValidator().validate(namon);
-        this._px = namon;
-        return this;
-    }
-    /**
-     * Builds with firstname
-     * @param namon a piece of string that will be defined as a namon
-     * @param more additional pieces considered as a given name
-     */
-    firstname(namon, ...more) {
-        this._fn = new index_1.Firstname(namon, ...more);
-        if (!this.bypass)
-            new validators_1.FirstnameValidator().validate(this._fn.tostring());
-        return this;
-    }
-    /**
-     * Builds with middlename
-     * @param nama middle names
-     */
-    middlename(...nama) {
-        const validator = new validators_1.NamonValidator();
-        this._mn = nama.map(namon => {
-            if (!this.bypass)
-                validator.validate(namon);
-            return new index_1.Name(namon, index_1.Namon.MIDDLE_NAME);
-        });
-        return this;
-    }
-    /**
-     * Builds with lastname
-     * @param father a piece of string that will be defined as a namon
-     * @param mother additional pieces considered as a last name
-     * @param format how to output a surname considering its subparts
-     */
-    lastname(father, mother, format = 'father') {
-        this._ln = new index_1.Lastname(father, mother, format);
-        if (!this.bypass)
-            new validators_1.LastnameValidator().validate(this._ln.tostring());
-        return this;
-    }
-    /**
-     * Builds with suffix
-     * @param namon suffix name part
-     */
-    suffix(namon) {
-        if (!this.bypass)
-            new validators_1.SuffixValidator().validate(namon);
-        this._sx = namon;
-        return this;
-    }
-    /**
-     * Builds a `Fulllname`
-     */
-    build() {
-        const fullname = {
-            firstname: this._fn,
-            lastname: this._ln,
-            middlename: this._mn,
-            prefix: this._px,
-            suffix: this._sx
-        };
-        return fullname;
-    }
-}
-exports.FullnameBuilder = FullnameBuilder;
-FullnameBuilder.prototype.px = FullnameBuilder.prototype.prefix;
-FullnameBuilder.prototype.fn = FullnameBuilder.prototype.firstname;
-FullnameBuilder.prototype.mn = FullnameBuilder.prototype.middlename;
-FullnameBuilder.prototype.ln = FullnameBuilder.prototype.lastname;
-FullnameBuilder.prototype.sx = FullnameBuilder.prototype.sx;
-//# sourceMappingURL=fullname.js.map

package/dist/lib/models/fullname.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fullname.js","sourceRoot":"","sources":["../../../src/models/fullname.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,mCAA2E;AAE3E,8CAMsB;AActB;;GAEG;AACH,MAAa,eAAe;IAOxB,YAAoB,SAAkB,KAAK;QAAvB,WAAM,GAAN,MAAM,CAAiB;QANnC,QAAG,GAAW,IAAI,CAAC;QACnB,QAAG,GAAc,IAAI,CAAC;QACtB,QAAG,GAAW,EAAE,CAAC;QACjB,QAAG,GAAa,IAAI,CAAC;QACrB,QAAG,GAAW,IAAI,CAAC;IAEmB,CAAC;IAE/C;;;OAGG;IACH,MAAM,CAAC,KAAa;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,4BAAe,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxD,IAAI,CAAC,GAAG,GAAG,KAAe,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,KAAa,EAAE,GAAG,IAAc;QACtC,IAAI,CAAC,GAAG,GAAG,IAAI,iBAAS,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,+BAAkB,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,GAAG,IAAc;QACxB,MAAM,SAAS,GAAG,IAAI,2BAAc,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC5C,OAAO,IAAI,YAAI,CAAC,KAAK,EAAE,aAAK,CAAC,WAAW,CAAC,CAAA;QAC7C,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,MAAc,EAAE,MAAe,EAAE,SAAyB,QAAQ;QACvE,IAAI,CAAC,GAAG,GAAG,IAAI,gBAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,8BAAiB,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAa;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,IAAI,4BAAe,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxD,IAAI,CAAC,GAAG,GAAG,KAAe,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK;QACD,MAAM,QAAQ,GAAa;YACvB,SAAS,EAAE,IAAI,CAAC,GAAG;YACnB,QAAQ,EAAE,IAAI,CAAC,GAAG;YAClB,UAAU,EAAE,IAAI,CAAC,GAAG;YACpB,MAAM,EAAE,IAAI,CAAC,GAAG;YAChB,MAAM,EAAE,IAAI,CAAC,GAAG;SACnB,CAAC;QACF,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AA9ED,0CA8EC;AAaD,eAAe,CAAC,SAAS,CAAC,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC;AAChE,eAAe,CAAC,SAAS,CAAC,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,SAAS,CAAC;AACnE,eAAe,CAAC,SAAS,CAAC,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,UAAU,CAAC;AACpE,eAAe,CAAC,SAAS,CAAC,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,QAAQ,CAAC;AAClE,eAAe,CAAC,SAAS,CAAC,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC"}

package/dist/lib/models/index.d.ts

@@ -1,13 +0,0 @@
-/**
- * Make all the locals available
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-export * from './name';
-export * from './firstname';
-export * from './lastname';
-export * from './enums';
-export * from './summary';
-export * from './misc';
-export * from './fullname';

package/dist/lib/models/index.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-/**
- * Make all the locals available
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-tslib_1.__exportStar(require("./name"), exports);
-tslib_1.__exportStar(require("./firstname"), exports);
-tslib_1.__exportStar(require("./lastname"), exports);
-tslib_1.__exportStar(require("./enums"), exports);
-tslib_1.__exportStar(require("./summary"), exports);
-tslib_1.__exportStar(require("./fullname"), exports);
-//# sourceMappingURL=index.js.map

package/dist/lib/models/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,iDAAuB;AACvB,sDAA4B;AAC5B,qDAA2B;AAC3B,kDAAwB;AACxB,oDAA0B;AAE1B,qDAA2B"}

package/dist/lib/models/lastname.d.ts

@@ -1,80 +0,0 @@
-/**
- * Last name class definition
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Name, Summary, LastnameFormat } from './index';
-/**
- * Represents a last name with some extra functionalities
- * @class
- * @extends Name
- */
-export declare class Lastname extends Name {
-    father: string;
-    mother?: string;
-    private format;
-    /**
-     * Constructs a `Lastname`
-     * @param {string} father a piece of string that will be defined as a namon
-     * @param {string} [mother] additional pieces considered as a last name
-     * @param {LastnameFormat} [format] how to output a surname considering its
-     * subparts
-     */
-    constructor(father: string, mother?: string, format?: LastnameFormat);
-    /**
-     * Determines whether a 'mother' subpart was set
-     */
-    hasMother(): boolean;
-    /**
-     * Gives some descriptive statistics that summarize the central tendency,
-     * dispersion and shape of the characters' distribution.
-     * @param {LastnameFormat} [format] overrides the how-to format of a surname
-     * output, considering its subparts.
-     * @see {@link describe} in `Namefully` class for further information
-     */
-    describe(format?: LastnameFormat): Summary;
-    /**
-     * Returns a string representation of the last name
-     * @param {LastnameFormat} [format] overrides the how-to format of a surname
-     * output, considering its subparts.
-     */
-    tostring(format?: LastnameFormat): string;
-    /**
-     * Gets the initials of the last name
-     */
-    getInitials(format?: LastnameFormat): string[];
-    /**
-     * Capitalizes a last name
-     * @param {'initial' | 'all'} option how to capitalize its subparts
-     */
-    capitalize(option?: 'initial' | 'all'): Lastname;
-    /**
-     * De-capitalizes a last name
-     * @param {'initial' | 'all'} option how to decapitalize its subparts
-     */
-    decapitalize(option?: 'initial' | 'all'): Lastname;
-    /**
-     * Normalizes the last name as it should be
-     */
-    normalize(): Lastname;
-    /**
-     * Returns an ascii representation of each characters of a last name
-     * @param restrictions chars to skip
-     */
-    ascii(restrictions?: string[]): number[];
-    /**
-     * Returns a password-like representation of a last name
-     */
-    passwd(): string;
-}
-/**
- * Aliases for `Lastname`
- */
-export interface Lastname {
-    cap: typeof Lastname.prototype.capitalize;
-    decap: typeof Lastname.prototype.decapitalize;
-    norm: typeof Lastname.prototype.normalize;
-    stats: typeof Lastname.prototype.describe;
-    inits: typeof Lastname.prototype.getInitials;
-}

package/dist/lib/models/lastname.js

@@ -1,157 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Last name class definition
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const index_1 = require("./index");
-const core_1 = require("../core");
-/**
- * Represents a last name with some extra functionalities
- * @class
- * @extends Name
- */
-class Lastname extends index_1.Name {
-    /**
-     * Constructs a `Lastname`
-     * @param {string} father a piece of string that will be defined as a namon
-     * @param {string} [mother] additional pieces considered as a last name
-     * @param {LastnameFormat} [format] how to output a surname considering its
-     * subparts
-     */
-    constructor(father, mother, format = 'father') {
-        super(father, index_1.Namon.LAST_NAME);
-        this.father = father;
-        this.mother = mother;
-        this.format = format;
-    }
-    /**
-     * Determines whether a 'mother' subpart was set
-     */
-    hasMother() {
-        return !!this.mother && this.mother.length > 0;
-    }
-    /**
-     * Gives some descriptive statistics that summarize the central tendency,
-     * dispersion and shape of the characters' distribution.
-     * @param {LastnameFormat} [format] overrides the how-to format of a surname
-     * output, considering its subparts.
-     * @see {@link describe} in `Namefully` class for further information
-     */
-    describe(format) {
-        format = format || this.format;
-        return new index_1.Summary(this.tostring(format));
-    }
-    /**
-     * Returns a string representation of the last name
-     * @param {LastnameFormat} [format] overrides the how-to format of a surname
-     * output, considering its subparts.
-     */
-    tostring(format) {
-        format = format || this.format;
-        switch (format) {
-            case 'father':
-                return this.father;
-            case 'mother':
-                return this.mother || index_1.Separator.EMPTY;
-            case 'hyphenated':
-                return this.mother ? this.father.concat(index_1.Separator.HYPHEN, this.mother) : this.father;
-            case 'all':
-                return this.mother ? this.father.concat(index_1.Separator.SPACE, this.mother) : this.father;
-        }
-    }
-    /**
-     * Gets the initials of the last name
-     */
-    getInitials(format) {
-        format = format || this.format;
-        const initials = [];
-        switch (format) {
-            case 'father':
-                initials.push(this.father[0]);
-                break;
-            case 'mother':
-                if (this.hasMother())
-                    initials.push(this.mother[0]);
-                break;
-            case 'hyphenated':
-            case 'all':
-                initials.push(this.father[0]);
-                if (this.hasMother())
-                    initials.push(this.mother[0]);
-                break;
-        }
-        return initials;
-    }
-    /**
-     * Capitalizes a last name
-     * @param {'initial' | 'all'} option how to capitalize its subparts
-     */
-    capitalize(option = 'initial') {
-        super.capitalize(option);
-        if (option === 'initial') {
-            this.father = this.father[0].toUpperCase().concat(this.father.slice(1));
-            if (this.hasMother())
-                this.mother = this.mother[0].toUpperCase().concat(this.mother.slice(1));
-        }
-        else {
-            this.father = this.father.toUpperCase();
-            if (this.hasMother())
-                this.mother = this.mother.toUpperCase();
-        }
-        return this;
-    }
-    /**
-     * De-capitalizes a last name
-     * @param {'initial' | 'all'} option how to decapitalize its subparts
-     */
-    decapitalize(option = 'initial') {
-        super.capitalize(option);
-        if (option === 'initial') {
-            this.father = this.father[0].toLowerCase().concat(this.father.slice(1));
-            if (this.hasMother())
-                this.mother = this.mother[0].toLowerCase().concat(this.mother.slice(1));
-        }
-        else {
-            this.father = this.father.toLowerCase();
-            if (this.hasMother())
-                this.mother = this.mother.toLowerCase();
-        }
-        return this;
-    }
-    /**
-     * Normalizes the last name as it should be
-     */
-    normalize() {
-        this.father = this.father[0]
-            .toUpperCase()
-            .concat(this.father.slice(1).toLowerCase());
-        if (this.hasMother())
-            this.mother = this.mother[0]
-                .toUpperCase()
-                .concat(this.mother.slice(1).toLowerCase());
-        return this;
-    }
-    /**
-     * Returns an ascii representation of each characters of a last name
-     * @param restrictions chars to skip
-     */
-    ascii(restrictions) {
-        return core_1.convertToAscii(this.tostring(), restrictions);
-    }
-    /**
-     * Returns a password-like representation of a last name
-     */
-    passwd() {
-        return core_1.generatePassword(this.tostring());
-    }
-}
-exports.Lastname = Lastname;
-Lastname.prototype.cap = Lastname.prototype.capitalize;
-Lastname.prototype.decap = Lastname.prototype.decapitalize;
-Lastname.prototype.norm = Lastname.prototype.normalize;
-Lastname.prototype.stats = Lastname.prototype.describe;
-Lastname.prototype.inits = Lastname.prototype.getInitials;
-//# sourceMappingURL=lastname.js.map

package/dist/lib/models/lastname.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"lastname.js","sourceRoot":"","sources":["../../../src/models/lastname.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,mCAA0E;AAC1E,kCAA2D;AAE3D;;;;GAIG;AACH,MAAa,QAAS,SAAQ,YAAI;IAE9B;;;;;;OAMG;IACH,YAAmB,MAAc,EAAS,MAAe,EAAU,SAAyB,QAAQ;QAChG,KAAK,CAAC,MAAM,EAAE,aAAK,CAAC,SAAS,CAAC,CAAC;QADhB,WAAM,GAAN,MAAM,CAAQ;QAAS,WAAM,GAAN,MAAM,CAAS;QAAU,WAAM,GAAN,MAAM,CAA2B;IAEpG,CAAC;IAED;;OAEG;IACH,SAAS;QACL,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,MAAuB;QAC5B,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QAC/B,OAAO,IAAI,eAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAuB;QAC5B,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QAC/B,QAAO,MAAM,EAAE;YACX,KAAK,QAAQ;gBACT,OAAO,IAAI,CAAC,MAAM,CAAC;YACvB,KAAK,QAAQ;gBACT,OAAO,IAAI,CAAC,MAAM,IAAI,iBAAS,CAAC,KAAK,CAAC;YAC1C,KAAK,YAAY;gBACb,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAS,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YACzF,KAAK,KAAK;gBACN,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;SAC3F;IACL,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAuB;QAC/B,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QAC/B,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,QAAO,MAAM,EAAE;YACX,KAAK,QAAQ;gBACT,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,MAAM;YACV,KAAK,QAAQ;gBACT,IAAI,IAAI,CAAC,SAAS,EAAE;oBAChB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAClC,MAAM;YACV,KAAK,YAAY,CAAC;YAAC,KAAK,KAAK;gBACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,IAAI,CAAC,SAAS,EAAE;oBAChB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAClC,MAAM;SACb;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,SAA4B,SAAS;QAC5C,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACzB,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACxE,IAAI,IAAI,CAAC,SAAS,EAAE;gBAChB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/E;aAAM;YACH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,SAAS,EAAE;gBAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;SACjE;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,SAA4B,SAAS;QAC9C,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACzB,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACxE,IAAI,IAAI,CAAC,SAAS,EAAE;gBAChB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/E;aAAM;YACH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,SAAS,EAAE;gBAChB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,SAAS;QACL,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;aACvB,WAAW,EAAE;aACb,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAChD,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;iBACvB,WAAW,EAAE;iBACb,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAuB;QACzB,OAAO,qBAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,YAAY,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM;QACF,OAAO,uBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;CACJ;AA1ID,4BA0IC;AAaD,QAAQ,CAAC,SAAS,CAAC,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC;AACvD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC;AAC3D,QAAQ,CAAC,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC;AACvD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC;AACvD,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC"}