dequanto 0.2.38 → 0.2.41

package/lib/esm/abi/fragments.mjs

@@ -33,7 +33,7 @@ function setify(items) {
 }
 const _kwVisibDeploy = "external public payable";
 const KwVisibDeploy = setify(_kwVisibDeploy.split(" "));
-// Visibility Keywords
+// Visibility keywords
 const _kwVisib = "constant external internal payable private public pure view";
 const KwVisib = setify(_kwVisib.split(" "));
 const _kwTypes = "constructor error event fallback function receive struct";
@@ -41,10 +41,10 @@ const KwTypes = setify(_kwTypes.split(" "));
 const _kwModifiers = "calldata memory storage payable indexed";
 const KwModifiers = setify(_kwModifiers.split(" "));
 const _kwOther = "tuple returns";
-// All Keywords
+// All keywords
 const _keywords = [_kwTypes, _kwModifiers, _kwOther, _kwVisib].join(" ");
 const Keywords = setify(_keywords.split(" "));
-// Single character tokens
+// Single-character tokens
 const SimpleTokens = {
     "(": "OPEN_PAREN", ")": "CLOSE_PAREN",
     "[": "OPEN_BRACKET", "]": "CLOSE_BRACKET",
@@ -54,7 +54,7 @@ const SimpleTokens = {
 const regexWhitespacePrefix = new RegExp("^(\\s*)");
 const regexNumberPrefix = new RegExp("^([0-9]+)");
 const regexIdPrefix = new RegExp("^([a-zA-Z$_][a-zA-Z0-9$_]*)");
-// Parser regexs to check validity
+// Parser regexes to check validity
 const regexId = new RegExp("^([a-zA-Z$_][a-zA-Z0-9$_]*)$");
 const regexType = new RegExp("^(address|bool|bytes([0-9]*)|string|u?int([0-9]*))$");
 class TokenString {
@@ -69,7 +69,7 @@ class TokenString {
     }
     clone() { return new TokenString(__classPrivateFieldGet(this, _TokenString_tokens, "f")); }
     reset() { __classPrivateFieldSet(this, _TokenString_offset, 0, "f"); }
-    // Pops and returns the value of the next token, if it is a keyword in allowed; throws if out of tokens
+    // Pops and returns the value of the next token if it is a keyword in `allowed`; throws if out of tokens
     popKeyword(allowed) {
         const top = this.peek();
         if (top.type !== "KEYWORD" || !allowed.has(top.text)) {
@@ -84,7 +84,7 @@ class TokenString {
         }
         return this.pop().text;
     }
-    // Pops and returns a "(" TOKENS ")"
+    // Pops and returns "(" TOKENS ")"
     popParen() {
         const top = this.peek();
         if (top.type !== "OPEN_PAREN") {
@@ -109,14 +109,14 @@ class TokenString {
         __classPrivateFieldSet(this, _TokenString_offset, top.match + 1, "f");
         return result;
     }
-    // Returns the top Token, throwing if out of tokens
+    // Returns the top token, throwing if out of tokens
     peek() {
         if (__classPrivateFieldGet(this, _TokenString_offset, "f") >= __classPrivateFieldGet(this, _TokenString_tokens, "f").length) {
             throw new Error("out-of-bounds");
         }
         return __classPrivateFieldGet(this, _TokenString_tokens, "f")[__classPrivateFieldGet(this, _TokenString_offset, "f")];
     }
-    // Returns the next value, if it is a keyword in `allowed`
+    // Returns the next value if it is a keyword in `allowed`
     peekKeyword(allowed) {
         const top = this.peekType("KEYWORD");
         return (top != null && allowed.has(top)) ? top : null;
@@ -241,7 +241,7 @@ function lex(text) {
     }
     return new TokenString(tokens.map((t) => Object.freeze(t)));
 }
-// Check only one of `allowed` is in `set`
+// Check that only one item from `allowed` is in `set`
 function allowSingle(set, allowed) {
     let included = [];
     for (const key in allowed.keys()) {
@@ -253,7 +253,7 @@ function allowSingle(set, allowed) {
         throw new Error(`conflicting types: ${included.join(", ")}`);
     }
 }
-// Functions to process a Solidity Signature TokenString from left-to-right for...
+// Functions to process a Solidity signature TokenString from left to right for..
 // ...the name with an optional type, returning the name
 function consumeName(type, tokens) {
     if (tokens.peekKeyword(KwTypes)) {
@@ -264,7 +264,7 @@ function consumeName(type, tokens) {
     }
     return tokens.popType("ID");
 }
-// ...all keywords matching allowed, returning the keywords
+// ...all keywords matching `allowed`, returning the keywords
 function consumeKeywords(tokens, allowed) {
     const keywords = new Set();
     while (true) {
@@ -316,7 +316,7 @@ function consumeGas(tokens) {
         if (tokens.peekType("NUMBER")) {
             return $bigint.toBigInt(tokens.pop().text);
         }
-        throw new Error("invalid gas");
+        throw new Error("Invalid gas");
     }
     return null;
 }
@@ -328,7 +328,7 @@ function consumeEoi(tokens) {
 const regexArrayType = new RegExp(/^(.*)\[([0-9]*)\]$/);
 function verifyBasicType(type) {
     const match = type.match(regexType);
-    $require.notNull(match, `invalid type ${type}`);
+    $require.notNull(match, `Invalid type ${type}`);
     if (type === "uint") {
         return "uint256";
     }
@@ -338,12 +338,12 @@ function verifyBasicType(type) {
     if (match[2]) {
         // bytesXX
         const length = parseInt(match[2]);
-        $require.True(length !== 0 && length <= 32, "invalid bytes length" + type);
+        $require.True(length !== 0 && length <= 32, "Invalid bytes length" + type);
     }
     else if (match[3]) {
         // intXX or uintXX
         const size = parseInt(match[3]);
-        $require.True(size !== 0 && size <= 256 && (size % 8) === 0, "invalid numeric width" + type);
+        $require.True(size !== 0 && size <= 256 && (size % 8) === 0, "Invalid numeric width" + type);
     }
     return type;
 }
@@ -358,7 +358,7 @@ const _guard = {};
 // const FunctionFragmentInternal = "_FunctionInternal";
 // const StructFragmentInternal = "_StructInternal";
 /**
- *  Each input and output of a [[Fragment]] is an Array of **ParamType**.
+ *  Each input and output of a [[Fragment]] is an Array of **ParamType**
  */
 export class ParamType {
     /**
@@ -393,7 +393,7 @@ export class ParamType {
         this.arrayChildren = arrayChildren;
     }
     /**
-     *  Return a string representation of this type.
+     *  Return a string representation of this type
      *
      *  For example,
      *
@@ -453,53 +453,53 @@ export class ParamType {
         return result;
     }
     /**
-     *  Returns true if %%this%% is an Array type.
+     *  Returns true if %%this%% is an Array type
      *
      *  This provides a type gaurd ensuring that [[arrayChildren]]
-     *  and [[arrayLength]] are non-null.
+     *  and [[arrayLength]] are non-null
      */
     isArray() {
         return (this.baseType === "array");
     }
     /**
-     *  Returns true if %%this%% is a Tuple type.
+     *  Returns true if %%this%% is a Tuple type
      *
      *  This provides a type gaurd ensuring that [[components]]
-     *  is non-null.
+     *  is non-null
      */
     isTuple() {
         return (this.baseType === "tuple");
     }
     /**
-     *  Returns true if %%this%% is an Indexable type.
+     *  Returns true if %%this%% is an Indexable type
      *
      *  This provides a type gaurd ensuring that [[indexed]]
-     *  is non-null.
+     *  is non-null
      */
     isIndexable() {
         return (this.indexed != null);
     }
     /**
      *  Walks the **ParamType** with %%value%%, calling %%process%%
-     *  on each type, destructing the %%value%% recursively.
+     *  on each type, destructing the %%value%% recursively
      */
     walk(value, process) {
         if (this.isArray()) {
             if (!Array.isArray(value)) {
-                throw new Error("invalid array value");
+                throw new Error("Invalid array value");
             }
             if (this.arrayLength !== -1 && value.length !== this.arrayLength) {
-                throw new Error("array is wrong length");
+                throw new Error("Array has the wrong length");
             }
             const _this = this;
             return value.map((v) => (_this.arrayChildren.walk(v, process)));
         }
         if (this.isTuple()) {
             if (!Array.isArray(value)) {
-                throw new Error("invalid tuple value");
+                throw new Error("Invalid tuple value");
             }
             if (value.length !== this.components.length) {
-                throw new Error("array is wrong length");
+                throw new Error("Array has the wrong length");
             }
             const _this = this;
             return value.map((v, i) => (_this.components[i].walk(v, process)));
@@ -508,10 +508,10 @@ export class ParamType {
     }
     /**
      *  Walks the **ParamType** with %%value%%, asynchronously calling
-     *  %%process%% on each type, destructing the %%value%% recursively.
+     *  %%process%% on each type, destructing the %%value%% recursively
      *
      *  This can be used to resolve ENS naes by walking and resolving each
-     *  ``"address"`` type.
+     *  ``"address"`` type
      */
     async walkAsync(value, process) {
         const promises = [];
@@ -525,10 +525,10 @@ export class ParamType {
         return result[0];
     }
     /**
-     *  Creates a new **ParamType** for %%obj%%.
+     *  Creates a new **ParamType** for %%obj%%
      *
      *  If %%allowIndexed%% then the ``indexed`` keyword is permitted,
-     *  otherwise the ``indexed`` keyword will throw an error.
+     *  otherwise the ``indexed`` keyword will throw an error
      */
     static from(obj, allowIndexed) {
         if (ParamType.isParamType(obj)) {
@@ -539,7 +539,7 @@ export class ParamType {
                 return ParamType.from(lex(obj), allowIndexed);
             }
             catch (error) {
-                throw new Error(`invalid param type: ${error.message}`);
+                throw new Error(`Invalid parameter type: ${error.message}`);
             }
         }
         else if (obj instanceof TokenString) {
@@ -577,15 +577,15 @@ export class ParamType {
             }
             const name = (obj.peekType("ID") ? obj.pop().text : "");
             if (obj.length) {
-                throw new Error("leftover tokens");
+                throw new Error("Leftover tokens");
             }
             return new ParamType(_guard, name, type, baseType, indexed, comps, arrayLength, arrayChildren);
         }
         const name = obj.name;
-        $require.True(!name || (typeof (name) === "string" && regexId.test(name)), "invalid name" + name);
+        $require.True(!name || (typeof (name) === "string" && regexId.test(name)), "Invalid name" + name);
         let indexed = obj.indexed;
         if (indexed != null) {
-            $require.True(allowIndexed ?? true, `parameter cannot be indexed: ${obj.indexed}`);
+            $require.True(allowIndexed ?? true, `Parameter cannot be indexed: ${obj.indexed}`);
             indexed = !!indexed;
         }
         let type = obj.type;
@@ -601,14 +601,14 @@ export class ParamType {
         if (type === "tuple" || type.startsWith("tuple(" /* fix: ) */) || type.startsWith("(" /* fix: ) */)) {
             const comps = (obj.components != null) ? obj.components.map((c) => ParamType.from(c)) : null;
             const tuple = new ParamType(_guard, name || "", type, "tuple", indexed, comps, null, null);
-            // @TODO: use lexer to validate and normalize type
+            // @TODO: Use the lexer to validate and normalize type
             return tuple;
         }
         type = verifyBasicType(obj.type);
         return new ParamType(_guard, name || "", type, type, indexed, null, null, null);
     }
     /**
-     *  Returns true if %%value%% is a **ParamType**.
+     *  Returns true if %%value%% is a **ParamType**
      */
     static isParamType(value) {
         return (value instanceof ParamType); //value[internal] === ParamTypeInternal);
@@ -617,10 +617,10 @@ export class ParamType {
 _ParamType_instances = new WeakSet(), _ParamType_walkAsync = function _ParamType_walkAsync(promises, value, process, setValue) {
     if (this.isArray()) {
         if (!Array.isArray(value)) {
-            throw new Error("invalid array value");
+            throw new Error("Invalid array value");
         }
         if (this.arrayLength !== -1 && value.length !== this.arrayLength) {
-            throw new Error("array is wrong length");
+            throw new Error("Array has the wrong length");
         }
         const childType = this.arrayChildren;
         const result = value.slice();
@@ -641,20 +641,20 @@ _ParamType_instances = new WeakSet(), _ParamType_walkAsync = function _ParamType
         }
         else {
             if (value == null || typeof (value) !== "object") {
-                throw new Error("invalid tuple value");
+                throw new Error("Invalid tuple value");
             }
             result = components.map((param) => {
                 if (!param.name) {
-                    throw new Error("cannot use object value with unnamed components");
+                    throw new Error("Cannot use object value with unnamed components");
                 }
                 if (!(param.name in value)) {
-                    throw new Error(`missing value for component ${param.name}`);
+                    throw new Error(`Missing value for component ${param.name}`);
                 }
                 return value[param.name];
             });
         }
         if (result.length !== this.components.length) {
-            throw new Error("array is wrong length");
+            throw new Error("Array has the wrong length");
         }
         result.forEach((value, index) => {
             var _a;
@@ -674,7 +674,7 @@ _ParamType_instances = new WeakSet(), _ParamType_walkAsync = function _ParamType
     }
 };
 /**
- *  An abstract class to represent An individual fragment from a parse ABI.
+ *  An abstract class to represent An individual fragment from a parse ABI
  */
 export class Fragment {
     /**
@@ -687,12 +687,12 @@ export class Fragment {
         this.inputs = inputs;
     }
     /**
-     *  Creates a new **Fragment** for %%obj%%, wich can be any supported
-     *  ABI frgament type.
+     *  Creates a new **Fragment** for %%obj%%, which can be any supported
+     *  ABI fragment type
      */
     static from(obj) {
         if (typeof (obj) === "string") {
-            // Try parsing JSON...
+            // Try parsing JSON..
             try {
                 Fragment.from(JSON.parse(obj));
             }
@@ -728,34 +728,34 @@ export class Fragment {
             }
             throw new Error(`UNSUPPORTED_OPERATION: unsupported type: ${obj.type}`);
         }
-        throw new Error("unsupported frgament object: " + JSON.stringify(obj));
+        throw new Error("unsupported fragment object: " + JSON.stringify(obj));
     }
     /**
-     *  Returns true if %%value%% is a [[ConstructorFragment]].
+     *  Returns true if %%value%% is a [[ConstructorFragment]]
      */
     static isConstructor(value) {
         return ConstructorFragment.isFragment(value);
     }
     /**
-     *  Returns true if %%value%% is an [[ErrorFragment]].
+     *  Returns true if %%value%% is an [[ErrorFragment]]
      */
     static isError(value) {
         return ErrorFragment.isFragment(value);
     }
     /**
-     *  Returns true if %%value%% is an [[EventFragment]].
+     *  Returns true if %%value%% is an [[EventFragment]]
      */
     static isEvent(value) {
         return EventFragment.isFragment(value);
     }
     /**
-     *  Returns true if %%value%% is a [[FunctionFragment]].
+     *  Returns true if %%value%% is a [[FunctionFragment]]
      */
     static isFunction(value) {
         return FunctionFragment.isFragment(value);
     }
     /**
-     *  Returns true if %%value%% is a [[StructFragment]].
+     *  Returns true if %%value%% is a [[StructFragment]]
      */
     static isStruct(value) {
         return StructFragment.isFragment(value);
@@ -763,7 +763,7 @@ export class Fragment {
 }
 /**
  *  An abstract class to represent An individual fragment
- *  which has a name from a parse ABI.
+ *  which has a name from a parse ABI
  */
 export class NamedFragment extends Fragment {
     /**
@@ -771,7 +771,7 @@ export class NamedFragment extends Fragment {
      */
     constructor(guard, type, name, inputs) {
         super(guard, type, inputs);
-        $require.True(typeof (name) === "string" && regexId.test(name), "invalid identifier " + name);
+        $require.True(typeof (name) === "string" && regexId.test(name), "Invalid identifier " + name);
         //-inputs = Object.freeze(inputs.slice());
         this.name = name;
     }
@@ -780,7 +780,7 @@ function joinParams(format, params) {
     return "(" + params.map((p) => p.format(format)).join((format === "full") ? ", " : ",") + ")";
 }
 /**
- *  A Fragment which represents a //Custom Error//.
+ *  A Fragment which represents a //Custom Error//
  */
 export class ErrorFragment extends NamedFragment {
     /**
@@ -791,13 +791,13 @@ export class ErrorFragment extends NamedFragment {
         //Object.defineProperty(this, internal, { value: ErrorFragmentInternal });
     }
     /**
-     *  The Custom Error selector.
+     *  The Custom Error selector
      */
     get selector() {
         return $contract.keccak256(this.format("sighash")).substring(0, 10);
     }
     /**
-     *  Returns a string representation of this fragment as %%format%%.
+     *  Returns a string representation of this fragment as %%format%%
      */
     format(format) {
         if (format == null) {
@@ -818,7 +818,7 @@ export class ErrorFragment extends NamedFragment {
         return result.join(" ");
     }
     /**
-     *  Returns a new **ErrorFragment** for %%obj%%.
+     *  Returns a new **ErrorFragment** for %%obj%%
      */
     static from(obj) {
         if (ErrorFragment.isFragment(obj)) {
@@ -837,14 +837,14 @@ export class ErrorFragment extends NamedFragment {
     }
     /**
      *  Returns ``true`` and provides a type guard if %%value%% is an
-     *  **ErrorFragment**.
+     *  **ErrorFragment**
      */
     static isFragment(value) {
         return (value instanceof ErrorFragment); //[internal] === ErrorFragmentInternal);
     }
 }
 /**
- *  A Fragment which represents an Event.
+ *  A Fragment which represents an Event
  */
 export class EventFragment extends NamedFragment {
     /**
@@ -856,13 +856,13 @@ export class EventFragment extends NamedFragment {
         this.anonymous = anonymous;
     }
     /**
-     *  The Event topic hash.
+     *  The Event topic hash
      */
     get topicHash() {
         return $contract.keccak256(this.format("sighash"));
     }
     /**
-     *  Returns a string representation of this event as %%format%%.
+     *  Returns a string representation of this event as %%format%%
      */
     format(format) {
         if (format == null) {
@@ -887,7 +887,7 @@ export class EventFragment extends NamedFragment {
         return result.join(" ");
     }
     /**
-     *  Return the topic hash for an event with %%name%% and %%params%%.
+     *  Return the topic hash for an event with %%name%% and %%params%%
      */
     static getTopicHash(name, params) {
         params = (params || []).map((p) => ParamType.from(p));
@@ -895,7 +895,7 @@ export class EventFragment extends NamedFragment {
         return fragment.topicHash;
     }
     /**
-     *  Returns a new **EventFragment** for %%obj%%.
+     *  Returns a new **EventFragment** for %%obj%%
      */
     static from(obj) {
         if (EventFragment.isFragment(obj)) {
@@ -906,7 +906,7 @@ export class EventFragment extends NamedFragment {
                 return EventFragment.from(lex(obj));
             }
             catch (error) {
-                throw new Error("invalid event fragment: " + JSON.stringify(obj));
+                throw new Error("Invalid event fragment: " + JSON.stringify(obj));
             }
         }
         else if (obj instanceof TokenString) {
@@ -920,14 +920,14 @@ export class EventFragment extends NamedFragment {
     }
     /**
      *  Returns ``true`` and provides a type guard if %%value%% is an
-     *  **EventFragment**.
+     *  **EventFragment**
      */
     static isFragment(value) {
         return (value instanceof EventFragment); //[internal] === EventFragmentInternal);
     }
 }
 /**
- *  A Fragment which represents a constructor.
+ *  A Fragment which represents a constructor
  */
 export class ConstructorFragment extends Fragment {
     /**
@@ -940,7 +940,7 @@ export class ConstructorFragment extends Fragment {
         this.gas = gas;
     }
     /**
-     *  Returns a string representation of this constructor as %%format%%.
+     *  Returns a string representation of this constructor as %%format%%
      */
     format(format) {
         $require.True(format != null && format !== "sighash", "UNSUPPORTED_OPERATION: cannot format a constructor for sighash");
@@ -961,7 +961,7 @@ export class ConstructorFragment extends Fragment {
         return result.join(" ");
     }
     /**
-     *  Returns a new **ConstructorFragment** for %%obj%%.
+     *  Returns a new **ConstructorFragment** for %%obj%%
      */
     static from(obj) {
         if (ConstructorFragment.isFragment(obj)) {
@@ -972,7 +972,7 @@ export class ConstructorFragment extends Fragment {
                 return ConstructorFragment.from(lex(obj));
             }
             catch (error) {
-                throw new Error("invalid constructor fragment: " + JSON.stringify(obj));
+                throw new Error("Invalid constructor fragment: " + JSON.stringify(obj));
             }
         }
         else if (obj instanceof TokenString) {
@@ -987,14 +987,14 @@ export class ConstructorFragment extends Fragment {
     }
     /**
      *  Returns ``true`` and provides a type guard if %%value%% is a
-     *  **ConstructorFragment**.
+     *  **ConstructorFragment**
      */
     static isFragment(value) {
         return (value instanceof ConstructorFragment); //[internal] === ConstructorFragmentInternal);
     }
 }
 /**
- *  A Fragment which represents a method.
+ *  A Fragment which represents a method
  */
 export class FallbackFragment extends Fragment {
     constructor(guard, inputs, payable) {
@@ -1003,7 +1003,7 @@ export class FallbackFragment extends Fragment {
         this.payable = payable;
     }
     /**
-     *  Returns a string representation of this fallback as %%format%%.
+     *  Returns a string representation of this fallback as %%format%%
      */
     format(format) {
         const type = ((this.inputs.length === 0) ? "receive" : "fallback");
@@ -1014,7 +1014,7 @@ export class FallbackFragment extends Fragment {
         return `${type}()${this.payable ? " payable" : ""}`;
     }
     /**
-     *  Returns a new **FallbackFragment** for %%obj%%.
+     *  Returns a new **FallbackFragment** for %%obj%%
      */
     static from(obj) {
         if (FallbackFragment.isFragment(obj)) {
@@ -1025,13 +1025,13 @@ export class FallbackFragment extends Fragment {
                 return FallbackFragment.from(lex(obj));
             }
             catch (error) {
-                throw new Error("invalid fallback fragment: " + JSON.stringify(obj));
+                throw new Error("Invalid fallback fragment: " + JSON.stringify(obj));
             }
         }
         else if (obj instanceof TokenString) {
             const errorObj = obj.toString();
             const topIsValid = obj.peekKeyword(setify(["fallback", "receive"]));
-            $require.notNull(topIsValid, "type must be fallback or receive " + errorObj);
+            $require.notNull(topIsValid, "Type must be fallback or receive " + errorObj);
             const type = obj.popKeyword(setify(["fallback", "receive"]));
             // receive()
             if (type === "receive") {
@@ -1069,18 +1069,18 @@ export class FallbackFragment extends Fragment {
             const payable = (obj.stateMutability === "payable");
             return new FallbackFragment(_guard, inputs, payable);
         }
-        throw new Error("invalid fallback fragment: " + JSON.stringify(obj));
+        throw new Error("Invalid fallback fragment: " + JSON.stringify(obj));
     }
     /**
      *  Returns ``true`` and provides a type guard if %%value%% is a
-     *  **FallbackFragment**.
+     *  **FallbackFragment**
      */
     static isFragment(value) {
         return (value instanceof FallbackFragment); //[internal] === FallbackFragmentInternal);
     }
 }
 /**
- *  A Fragment which represents a method.
+ *  A Fragment which represents a method
  */
 export class FunctionFragment extends NamedFragment {
     /**
@@ -1099,13 +1099,13 @@ export class FunctionFragment extends NamedFragment {
         this.stateMutability = stateMutability;
     }
     /**
-     *  The Function selector.
+     *  The Function selector
      */
     get selector() {
         return $contract.keccak256(this.format("sighash")).substring(0, 10);
     }
     /**
-     *  Returns a string representation of this function as %%format%%.
+     *  Returns a string representation of this function as %%format%%
      */
     format(format) {
         if (format == null) {
@@ -1143,7 +1143,7 @@ export class FunctionFragment extends NamedFragment {
         return result.join(" ");
     }
     /**
-     *  Return the selector for a function with %%name%% and %%params%%.
+     *  Return the selector for a function with %%name%% and %%params%%
      */
     static getSelector(name, params) {
         params = (params || []).map((p) => ParamType.from(p));
@@ -1151,7 +1151,7 @@ export class FunctionFragment extends NamedFragment {
         return fragment.selector;
     }
     /**
-     *  Returns a new **FunctionFragment** for %%obj%%.
+     *  Returns a new **FunctionFragment** for %%obj%%
      */
     static from(obj) {
         if (FunctionFragment.isFragment(obj)) {
@@ -1200,14 +1200,14 @@ export class FunctionFragment extends NamedFragment {
     }
     /**
      *  Returns ``true`` and provides a type guard if %%value%% is a
-     *  **FunctionFragment**.
+     *  **FunctionFragment**
      */
     static isFragment(value) {
         return (value instanceof FunctionFragment); //[internal] === FunctionFragmentInternal);
     }
 }
 /**
- *  A Fragment which represents a structure.
+ *  A Fragment which represents a structure
  */
 export class StructFragment extends NamedFragment {
     /**
@@ -1218,13 +1218,13 @@ export class StructFragment extends NamedFragment {
         //Object.defineProperty(this, internal, { value: StructFragmentInternal });
     }
     /**
-     *  Returns a string representation of this struct as %%format%%.
+     *  Returns a string representation of this struct as %%format%%
      */
     format() {
         throw new Error("@TODO");
     }
     /**
-     *  Returns a new **StructFragment** for %%obj%%.
+     *  Returns a new **StructFragment** for %%obj%%
      */
     static from(obj) {
         if (typeof (obj) === "string") {
@@ -1246,7 +1246,7 @@ export class StructFragment extends NamedFragment {
     // @TODO: fix this return type
     /**
      *  Returns ``true`` and provides a type guard if %%value%% is a
-     *  **StructFragment**.
+     *  **StructFragment**
      */
     static isFragment(value) {
         return (value instanceof StructFragment); //[internal] === StructFragmentInternal);