@zthun/helpful-fn 9.11.7 → 9.11.8

package/dist/enum/enum-info.d.mts

@@ -0,0 +1,87 @@
+/**
+ * Information for an enum value.
+ *
+ * This is useful for front end development when
+ * you want to map an enumeration like value to
+ * things like a display name, description, and
+ * avatar.  ECMAScript does not support decorators
+ * for literal fields so this is an alternative
+ * to describe that kind of information.
+ *
+ * This is similar to Metadata from helpful-query,
+ * but it's much more specific and specialized
+ * to enumerations.
+ */
+export interface IZEnumInformation<TEnum> {
+    /**
+     * The display name of the enum value.
+     */
+    name?: string;
+    /**
+     * The avatar representation of the enum.
+     *
+     * This can be anything and is contextual of how
+     * this object is used.
+     */
+    avatar?: any;
+    /**
+     * The description of the enum value.
+     */
+    description?: string;
+    /**
+     * The value being described.
+     */
+    value: TEnum;
+}
+/**
+ * Builds information for an enum.
+ */
+export declare class ZEnumInfoBuilder<TEnum> {
+    private _metadata;
+    /**
+     * Initializes a new instance of this object.
+     *
+     * @param value -
+     *        The value to initialize with.
+     */
+    constructor(value: TEnum);
+    /**
+     * The display name of the enum.
+     *
+     * @param name -
+     *        The display name of the enum.
+     *
+     * @returns
+     *        This object.
+     */
+    name(name: string): this;
+    /**
+     * Text description of the enum.
+     *
+     * @param description -
+     *        Text description of what the value means.
+     *
+     * @returns
+     *        This object.
+     */
+    description(description: string): this;
+    /**
+     * The avatar representation of the enum.
+     *
+     * @param avatar -
+     *        The avatar representation of what the value
+     *        is.  This can be anything but should be related
+     *        to the framework it is being developed for.
+     *
+     * @returns
+     *        This object.
+     */
+    avatar(avatar: any): this;
+    /**
+     * Returns a shallow copy of the metadata.
+     *
+     * @returns
+     *        A shallow copy of the metadata.
+     */
+    build(): IZEnumInformation<TEnum>;
+}

package/dist/index.cjs

@@ -44,7 +44,7 @@ const dateFns = require('date-fns');
     return ZHorizontalAnchor;
 }({});
 
-function _define_property$6(obj, key, value) {
+function _define_property$7(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -117,7 +117,7 @@ function _define_property$6(obj, key, value) {
     /**
    * Initializes a new instance of this object.
    */ constructor(){
-        _define_property$6(this, "_messages", []);
+        _define_property$7(this, "_messages", []);
     }
 }
 
@@ -604,6 +604,96 @@ function _define_property$6(obj, key, value) {
     return candidate == null || candidateType === "object" && Object.keys(candidate).length === 0;
 }
 
+/**
+ * Information for an enum value.
+ *
+ * This is useful for front end development when
+ * you want to map an enumeration like value to
+ * things like a display name, description, and
+ * avatar.  ECMAScript does not support decorators
+ * for literal fields so this is an alternative
+ * to describe that kind of information.
+ *
+ * This is similar to Metadata from helpful-query,
+ * but it's much more specific and specialized
+ * to enumerations.
+ */ function _define_property$6(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+/**
+ * Builds information for an enum.
+ */ class ZEnumInfoBuilder {
+    /**
+   * The display name of the enum.
+   *
+   * @param name -
+   *        The display name of the enum.
+   *
+   * @returns
+   *        This object.
+   */ name(name) {
+        this._metadata.name = name;
+        return this;
+    }
+    /**
+   * Text description of the enum.
+   *
+   * @param description -
+   *        Text description of what the value means.
+   *
+   * @returns
+   *        This object.
+   */ description(description) {
+        this._metadata.description = description;
+        return this;
+    }
+    /**
+   * The avatar representation of the enum.
+   *
+   * @param avatar -
+   *        The avatar representation of what the value
+   *        is.  This can be anything but should be related
+   *        to the framework it is being developed for.
+   *
+   * @returns
+   *        This object.
+   */ avatar(avatar) {
+        this._metadata.avatar = avatar;
+        return this;
+    }
+    /**
+   * Returns a shallow copy of the metadata.
+   *
+   * @returns
+   *        A shallow copy of the metadata.
+   */ build() {
+        return {
+            ...this._metadata
+        };
+    }
+    /**
+   * Initializes a new instance of this object.
+   *
+   * @param value -
+   *        The value to initialize with.
+   */ constructor(value){
+        _define_property$6(this, "_metadata", void 0);
+        this._metadata = {
+            value
+        };
+    }
+}
+
 const BYTES_PER_KIBIBYTE = 1024;
 const BYTES_PER_MEBIBYTE = 1048576; // 1024 ^ 2
 const BYTES_PER_GIBIBYTE = 1073741824; // 1024 ^ 3
@@ -2061,6 +2151,7 @@ exports.ZAssert = ZAssert;
 exports.ZDateFormats = ZDateFormats;
 exports.ZDeserializeJson = ZDeserializeJson;
 exports.ZDeserializeTry = ZDeserializeTry;
+exports.ZEnumInfoBuilder = ZEnumInfoBuilder;
 exports.ZHorizontalAnchor = ZHorizontalAnchor;
 exports.ZLazy = ZLazy;
 exports.ZOrientation = ZOrientation;