Include docstring to explain purpose of replaceWithSerializableTypeIfNeeded function

Author: rgroothuijsen

modules/openapi-generator/src/main/resources/typescript-axios/common.mustache

@@ -105,6 +105,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);

samples/client/echo_api/typescript-axios/build/common.ts

@@ -91,6 +91,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);

samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/common.ts

@@ -91,6 +91,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);

samples/client/petstore/typescript-axios/builds/composed-schemas/common.ts

@@ -91,6 +91,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);

samples/client/petstore/typescript-axios/builds/default/common.ts

@@ -91,6 +91,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);

samples/client/petstore/typescript-axios/builds/es6-target/common.ts

@@ -91,6 +91,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);

samples/client/petstore/typescript-axios/builds/test-petstore/common.ts

@@ -91,6 +91,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);

samples/client/petstore/typescript-axios/builds/with-complex-headers/common.ts

@@ -91,6 +91,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);

samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/common.ts

@@ -91,6 +91,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);

samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/common.ts

@@ -91,6 +91,11 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
     url.search = searchParams.toString();
 }
 
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
 export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
     if (value instanceof Set) {
         return Array.from(value);