[typescript-fetch] - Fix Nullable Types (#18887)

* fix nullable types

* fix samples

* fix samples

* fix samples

* fix samples

---------

Co-authored-by: Pierre Berube <pberube@blackpointcyber.com>
This commit is contained in:
Pierre B 2024-06-10 03:35:20 -06:00 committed by GitHub
parent 2851838f7f
commit f517bf7b98
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 38 additions and 38 deletions

View File

@ -24,7 +24,7 @@ import {
{{#allParams.0}} {{#allParams.0}}
export interface {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}Request { export interface {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}Request {
{{#allParams}} {{#allParams}}
{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{#hasReadOnly}}Omit<{{{dataType}}}, {{#readOnlyVars}}'{{baseName}}'{{^-last}}|{{/-last}}{{/readOnlyVars}}>{{/hasReadOnly}}{{^hasReadOnly}}{{{dataType}}}{{/hasReadOnly}}{{#isNullable}}{{#required}} | null{{/required}}{{/isNullable}}{{/isEnum}}; {{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{#hasReadOnly}}Omit<{{{dataType}}}, {{#readOnlyVars}}'{{baseName}}'{{^-last}}|{{/-last}}{{/readOnlyVars}}>{{/hasReadOnly}}{{^hasReadOnly}}{{{dataType}}}{{/hasReadOnly}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}};
{{/allParams}} {{/allParams}}
} }
@ -70,7 +70,7 @@ export interface {{classname}}Interface {
{{/isDeprecated}} {{/isDeprecated}}
*/ */
{{^useSingleRequestParameter}} {{^useSingleRequestParameter}}
{{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}}{{#required}} | null{{/required}}{{/isNullable}}{{/isEnum}}, {{/allParams}}initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{{{returnType}}}{{^returnType}}void{{/returnType}}>; {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{{{returnType}}}{{^returnType}}void{{/returnType}}>;
{{/useSingleRequestParameter}} {{/useSingleRequestParameter}}
{{#useSingleRequestParameter}} {{#useSingleRequestParameter}}
{{nickname}}({{#allParams.0}}requestParameters: {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}Request, {{/allParams.0}}initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{{{returnType}}}{{^returnType}}void{{/returnType}}>; {{nickname}}({{#allParams.0}}requestParameters: {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}Request, {{/allParams.0}}initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{{{returnType}}}{{^returnType}}void{{/returnType}}>;
@ -354,7 +354,7 @@ export class {{classname}} extends runtime.BaseAPI {
{{/isDeprecated}} {{/isDeprecated}}
*/ */
{{^useSingleRequestParameter}} {{^useSingleRequestParameter}}
async {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}}{{#required}} | null{{/required}}{{/isNullable}}{{/isEnum}}, {{/allParams}}initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{{{returnType}}}{{#returnType}}{{#isResponseOptional}} | null | undefined {{/isResponseOptional}}{{/returnType}}{{^returnType}}void{{/returnType}}> { async {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}, {{/allParams}}initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{{{returnType}}}{{#returnType}}{{#isResponseOptional}} | null | undefined {{/isResponseOptional}}{{/returnType}}{{^returnType}}void{{/returnType}}> {
{{#returnType}} {{#returnType}}
const response = await this.{{nickname}}Raw({{#allParams.0}}{ {{#allParams}}{{paramName}}: {{paramName}}{{^-last}}, {{/-last}}{{/allParams}} }, {{/allParams.0}}initOverrides); const response = await this.{{nickname}}Raw({{#allParams.0}}{ {{#allParams}}{{paramName}}: {{paramName}}{{^-last}}, {{/-last}}{{/allParams}} }, {{/allParams.0}}initOverrides);
{{#isResponseOptional}} {{#isResponseOptional}}

View File

@ -16,7 +16,7 @@ export interface {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{
* @deprecated * @deprecated
{{/deprecated}} {{/deprecated}}
*/ */
{{#isReadOnly}}readonly {{/isReadOnly}}{{name}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{#isNullable}}{{#required}} | null{{/required}}{{/isNullable}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{#isNullable}}{{#required}} | null{{/required}}{{/isNullable}}{{/isEnum}}; {{#isReadOnly}}readonly {{/isReadOnly}}{{name}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}};
{{/vars}} {{/vars}}
}{{#hasEnums}} }{{#hasEnums}}

View File

@ -31,7 +31,7 @@ export interface Club {
* @type {Owner} * @type {Owner}
* @memberof Club * @memberof Club
*/ */
owner?: Owner; owner?: Owner | null;
} }
/** /**

View File

@ -73,7 +73,7 @@ export interface EnumTest {
* @type {OuterEnum} * @type {OuterEnum}
* @memberof EnumTest * @memberof EnumTest
*/ */
outerEnum?: OuterEnum; outerEnum?: OuterEnum | null;
/** /**
* *
* @type {OuterEnumInteger} * @type {OuterEnumInteger}

View File

@ -24,7 +24,7 @@ export interface HealthCheckResult {
* @type {string} * @type {string}
* @memberof HealthCheckResult * @memberof HealthCheckResult
*/ */
nullableMessage?: string; nullableMessage?: string | null;
} }
/** /**

View File

@ -25,49 +25,49 @@ export interface NullableClass {
* @type {number} * @type {number}
* @memberof NullableClass * @memberof NullableClass
*/ */
integerProp?: number; integerProp?: number | null;
/** /**
* *
* @type {number} * @type {number}
* @memberof NullableClass * @memberof NullableClass
*/ */
numberProp?: number; numberProp?: number | null;
/** /**
* *
* @type {boolean} * @type {boolean}
* @memberof NullableClass * @memberof NullableClass
*/ */
booleanProp?: boolean; booleanProp?: boolean | null;
/** /**
* *
* @type {string} * @type {string}
* @memberof NullableClass * @memberof NullableClass
*/ */
stringProp?: string; stringProp?: string | null;
/** /**
* *
* @type {Date} * @type {Date}
* @memberof NullableClass * @memberof NullableClass
*/ */
dateProp?: Date; dateProp?: Date | null;
/** /**
* *
* @type {Date} * @type {Date}
* @memberof NullableClass * @memberof NullableClass
*/ */
datetimeProp?: Date; datetimeProp?: Date | null;
/** /**
* *
* @type {Array<object>} * @type {Array<object>}
* @memberof NullableClass * @memberof NullableClass
*/ */
arrayNullableProp?: Array<object>; arrayNullableProp?: Array<object> | null;
/** /**
* *
* @type {Array<object>} * @type {Array<object>}
* @memberof NullableClass * @memberof NullableClass
*/ */
arrayAndItemsNullableProp?: Array<object>; arrayAndItemsNullableProp?: Array<object> | null;
/** /**
* *
* @type {Array<object>} * @type {Array<object>}
@ -79,13 +79,13 @@ export interface NullableClass {
* @type {{ [key: string]: object; }} * @type {{ [key: string]: object; }}
* @memberof NullableClass * @memberof NullableClass
*/ */
objectNullableProp?: { [key: string]: object; }; objectNullableProp?: { [key: string]: object; } | null;
/** /**
* *
* @type {{ [key: string]: object | null; }} * @type {{ [key: string]: object | null; }}
* @memberof NullableClass * @memberof NullableClass
*/ */
objectAndItemsNullableProp?: { [key: string]: object | null; }; objectAndItemsNullableProp?: { [key: string]: object | null; } | null;
/** /**
* *
* @type {{ [key: string]: object | null; }} * @type {{ [key: string]: object | null; }}

View File

@ -31,7 +31,7 @@ export interface ParentWithNullable {
* @type {string} * @type {string}
* @memberof ParentWithNullable * @memberof ParentWithNullable
*/ */
nullableProperty?: string; nullableProperty?: string | null;
} }

View File

@ -40,9 +40,9 @@ export interface FakeEnumRequestGetInlineRequest {
export interface FakeEnumRequestGetRefRequest { export interface FakeEnumRequestGetRefRequest {
stringEnum?: StringEnum; stringEnum?: StringEnum;
nullableStringEnum?: StringEnum; nullableStringEnum?: StringEnum | null;
numberEnum?: NumberEnum; numberEnum?: NumberEnum;
nullableNumberEnum?: NumberEnum; nullableNumberEnum?: NumberEnum | null;
} }
export interface FakeEnumRequestPostInlineRequest { export interface FakeEnumRequestPostInlineRequest {

View File

@ -43,7 +43,7 @@ export interface EnumPatternObject {
* @type {StringEnum} * @type {StringEnum}
* @memberof EnumPatternObject * @memberof EnumPatternObject
*/ */
nullableStringEnum?: StringEnum; nullableStringEnum?: StringEnum | null;
/** /**
* *
* @type {NumberEnum} * @type {NumberEnum}
@ -55,7 +55,7 @@ export interface EnumPatternObject {
* @type {NumberEnum} * @type {NumberEnum}
* @memberof EnumPatternObject * @memberof EnumPatternObject
*/ */
nullableNumberEnum?: NumberEnum; nullableNumberEnum?: NumberEnum | null;
} }
/** /**

View File

@ -73,7 +73,7 @@ export interface EnumTest {
* @type {OuterEnum} * @type {OuterEnum}
* @memberof EnumTest * @memberof EnumTest
*/ */
outerEnum?: OuterEnum; outerEnum?: OuterEnum | null;
/** /**
* *
* @type {OuterEnumInteger} * @type {OuterEnumInteger}

View File

@ -24,7 +24,7 @@ export interface HealthCheckResult {
* @type {string} * @type {string}
* @memberof HealthCheckResult * @memberof HealthCheckResult
*/ */
nullableMessage?: string; nullableMessage?: string | null;
} }
/** /**

View File

@ -25,49 +25,49 @@ export interface NullableClass {
* @type {number} * @type {number}
* @memberof NullableClass * @memberof NullableClass
*/ */
integerProp?: number; integerProp?: number | null;
/** /**
* *
* @type {number} * @type {number}
* @memberof NullableClass * @memberof NullableClass
*/ */
numberProp?: number; numberProp?: number | null;
/** /**
* *
* @type {boolean} * @type {boolean}
* @memberof NullableClass * @memberof NullableClass
*/ */
booleanProp?: boolean; booleanProp?: boolean | null;
/** /**
* *
* @type {string} * @type {string}
* @memberof NullableClass * @memberof NullableClass
*/ */
stringProp?: string; stringProp?: string | null;
/** /**
* *
* @type {Date} * @type {Date}
* @memberof NullableClass * @memberof NullableClass
*/ */
dateProp?: Date; dateProp?: Date | null;
/** /**
* *
* @type {Date} * @type {Date}
* @memberof NullableClass * @memberof NullableClass
*/ */
datetimeProp?: Date; datetimeProp?: Date | null;
/** /**
* *
* @type {Array<object>} * @type {Array<object>}
* @memberof NullableClass * @memberof NullableClass
*/ */
arrayNullableProp?: Array<object>; arrayNullableProp?: Array<object> | null;
/** /**
* *
* @type {Array<object>} * @type {Array<object>}
* @memberof NullableClass * @memberof NullableClass
*/ */
arrayAndItemsNullableProp?: Array<object>; arrayAndItemsNullableProp?: Array<object> | null;
/** /**
* *
* @type {Array<object>} * @type {Array<object>}
@ -79,13 +79,13 @@ export interface NullableClass {
* @type {{ [key: string]: object; }} * @type {{ [key: string]: object; }}
* @memberof NullableClass * @memberof NullableClass
*/ */
objectNullableProp?: { [key: string]: object; }; objectNullableProp?: { [key: string]: object; } | null;
/** /**
* *
* @type {{ [key: string]: object | null; }} * @type {{ [key: string]: object | null; }}
* @memberof NullableClass * @memberof NullableClass
*/ */
objectAndItemsNullableProp?: { [key: string]: object | null; }; objectAndItemsNullableProp?: { [key: string]: object | null; } | null;
/** /**
* *
* @type {{ [key: string]: object | null; }} * @type {{ [key: string]: object | null; }}

View File

@ -40,9 +40,9 @@ export interface FakeEnumRequestGetInlineRequest {
export interface FakeEnumRequestGetRefRequest { export interface FakeEnumRequestGetRefRequest {
stringEnum?: StringEnum; stringEnum?: StringEnum;
nullableStringEnum?: StringEnum; nullableStringEnum?: StringEnum | null;
numberEnum?: NumberEnum; numberEnum?: NumberEnum;
nullableNumberEnum?: NumberEnum; nullableNumberEnum?: NumberEnum | null;
} }
export interface FakeEnumRequestPostInlineRequest { export interface FakeEnumRequestPostInlineRequest {

View File

@ -43,7 +43,7 @@ export interface EnumPatternObject {
* @type {StringEnum} * @type {StringEnum}
* @memberof EnumPatternObject * @memberof EnumPatternObject
*/ */
nullableStringEnum?: StringEnum; nullableStringEnum?: StringEnum | null;
/** /**
* *
* @type {NumberEnum} * @type {NumberEnum}
@ -55,7 +55,7 @@ export interface EnumPatternObject {
* @type {NumberEnum} * @type {NumberEnum}
* @memberof EnumPatternObject * @memberof EnumPatternObject
*/ */
nullableNumberEnum?: NumberEnum; nullableNumberEnum?: NumberEnum | null;
} }
/** /**