@twin.org/nameof 0.0.2-next.9 → 0.0.2

package/README.md

@@ -1,8 +1,6 @@
 # TWIN Nameof
 
-The methods in this package are used to convert TypeScript class/type/property names to embedded strings, so that they are available to your JavaScript code at runtime.
-
-This package is used in conjunction with the `@twin.org/nameof-transformer` package, without using the transformer for compilation you will end up with an error string embedded in your code instead of the runtime name you are expecting.
+This package is part of the framework workspace and provides the definitions for the methods which are processed by the nameof-transformer to support consistent development workflows across the ecosystem.
 
 ## Installation
 

package/dist/es/index.js

@@ -0,0 +1,33 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Placeholder method which substitutes the type name as a string at runtime.
+ * @param property The property to get the name of.
+ * @param replaceParent Optional object name to replace the top level object of a property path.
+ * @returns The type name as a string.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function nameof(property, replaceParent) {
+    return "@twin.org/nameof-transformer is not in the build pipeline, you need to use a compiler that supports transformer plugins.";
+}
+/**
+ * Placeholder method which substitutes the type name as a string at runtime.
+ * @param property The property to get the name of.
+ * @param replaceParent Optional object name to replace the top level object of a property path.
+ * @returns The type name as a string.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function nameofKebabCase(property, replaceParent) {
+    return "@twin.org/nameof-transformer is not in the build pipeline, you need to use a compiler that supports transformer plugins.";
+}
+/**
+ * Placeholder method which substitutes the type name as a string at runtime.
+ * @param property The property to get the name of.
+ * @param replaceParent Optional object name to replace the top level object of a property path.
+ * @returns The type name as a string.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function nameofCamelCase(property, replaceParent) {
+    return "@twin.org/nameof-transformer is not in the build pipeline, you need to use a compiler that supports transformer plugins.";
+}
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;;;GAKG;AACH,6DAA6D;AAC7D,MAAM,UAAU,MAAM,CAAI,QAAkB,EAAE,aAAsB;IACnE,OAAO,0HAA0H,CAAC;AACnI,CAAC;AAED;;;;;GAKG;AACH,6DAA6D;AAC7D,MAAM,UAAU,eAAe,CAAI,QAAkB,EAAE,aAAsB;IAC5E,OAAO,0HAA0H,CAAC;AACnI,CAAC;AAED;;;;;GAKG;AACH,6DAA6D;AAC7D,MAAM,UAAU,eAAe,CAAI,QAAkB,EAAE,aAAsB;IAC5E,OAAO,0HAA0H,CAAC;AACnI,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Placeholder method which substitutes the type name as a string at runtime.\n * @param property The property to get the name of.\n * @param replaceParent Optional object name to replace the top level object of a property path.\n * @returns The type name as a string.\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function nameof<T>(property?: unknown, replaceParent?: string): string {\n\treturn \"@twin.org/nameof-transformer is not in the build pipeline, you need to use a compiler that supports transformer plugins.\";\n}\n\n/**\n * Placeholder method which substitutes the type name as a string at runtime.\n * @param property The property to get the name of.\n * @param replaceParent Optional object name to replace the top level object of a property path.\n * @returns The type name as a string.\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function nameofKebabCase<T>(property?: unknown, replaceParent?: string): string {\n\treturn \"@twin.org/nameof-transformer is not in the build pipeline, you need to use a compiler that supports transformer plugins.\";\n}\n\n/**\n * Placeholder method which substitutes the type name as a string at runtime.\n * @param property The property to get the name of.\n * @param replaceParent Optional object name to replace the top level object of a property path.\n * @returns The type name as a string.\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function nameofCamelCase<T>(property?: unknown, replaceParent?: string): string {\n\treturn \"@twin.org/nameof-transformer is not in the build pipeline, you need to use a compiler that supports transformer plugins.\";\n}\n"]}

package/dist/types/index.d.ts

@@ -5,3 +5,17 @@
  * @returns The type name as a string.
  */
 export declare function nameof<T>(property?: unknown, replaceParent?: string): string;
+/**
+ * Placeholder method which substitutes the type name as a string at runtime.
+ * @param property The property to get the name of.
+ * @param replaceParent Optional object name to replace the top level object of a property path.
+ * @returns The type name as a string.
+ */
+export declare function nameofKebabCase<T>(property?: unknown, replaceParent?: string): string;
+/**
+ * Placeholder method which substitutes the type name as a string at runtime.
+ * @param property The property to get the name of.
+ * @param replaceParent Optional object name to replace the top level object of a property path.
+ * @returns The type name as a string.
+ */
+export declare function nameofCamelCase<T>(property?: unknown, replaceParent?: string): string;