Workers service binding Typescript types uses Rpc.Stub<null>

Hi team,
I cannot get TS return types working as expected when calling a method via service binding between Workers. My goal is to have the service return in the form:

type ServiceResponseSuccess<T> = {
    data: T;
    error: null;
};
type ServiceResponseFailure = {
    data: null;
    error: MyErrorObject;
};
export type ServiceResponse<T> = ServiceResponseFailure | ServiceResponseSuccess<T>;


// my-service.ts:
async myMethod(...): Promise<ServiceResponse<boolean>>;

type ServiceResponseSuccess<T> = {
    data: T;
    error: null;
};
type ServiceResponseFailure = {
    data: null;
    error: MyErrorObject;
};
export type ServiceResponse<T> = ServiceResponseFailure | ServiceResponseSuccess<T>;


// my-service.ts:
async myMethod(...): Promise<ServiceResponse<boolean>>;

and then the caller can do:

const { data, error } = await myService.myMethod(...);

const { data, error } = await myService.myMethod(...);

The issue is that the generated TS types for the service use

Rpc.Stub<null>

Rpc.Stub<null>

instead of raw

null

null

. And this does not play nice with anything the caller would want to do afterwards. For example,

if (error)

if (error)

does not work to check if we're in the error case, since

Rpc.Stub<null> != null

Rpc.Stub<null> != null

; and the same null-check doesn't work for the

data

data

object.

// generated TS return type for the service
Promise<{ data: Rpc.Stub<null>; error: {...}; }> 
| Promise<{ data: {...}; error: Rpc.Stub<null>; }>

// generated TS return type for the service
Promise<{ data: Rpc.Stub<null>; error: {...}; }> 
| Promise<{ data: {...}; error: Rpc.Stub<null>; }>

Btw, it appears to only use

Rpc.Stub<>

Rpc.Stub<>

for

null

null

and

undefined

undefined

. For all other types (number, boolean, custom types, etc) , the generated TS uses the actual type.

Cloudflare Developers•13mo ago

scook

Workers service binding Typescript types uses Rpc.Stub<null>

Hi team,
I cannot get TS return types working as expected when calling a method via service binding between Workers. My goal is to have the service return in the form:

type ServiceResponseSuccess<T> = {
    data: T;
    error: null;
};
type ServiceResponseFailure = {
    data: null;
    error: MyErrorObject;
};
export type ServiceResponse<T> = ServiceResponseFailure | ServiceResponseSuccess<T>;


// my-service.ts:
async myMethod(...): Promise<ServiceResponse<boolean>>;

type ServiceResponseSuccess<T> = {
    data: T;
    error: null;
};
type ServiceResponseFailure = {
    data: null;
    error: MyErrorObject;
};
export type ServiceResponse<T> = ServiceResponseFailure | ServiceResponseSuccess<T>;


// my-service.ts:
async myMethod(...): Promise<ServiceResponse<boolean>>;

and then the caller can do:

const { data, error } = await myService.myMethod(...);

const { data, error } = await myService.myMethod(...);

The issue is that the generated TS types for the service use

Rpc.Stub<null>

Rpc.Stub<null>

instead of raw

null

null

. And this does not play nice with anything the caller would want to do afterwards. For example,

if (error)

if (error)

does not work to check if we're in the error case, since

Rpc.Stub<null> != null

Rpc.Stub<null> != null

; and the same null-check doesn't work for the

data

data

object.

// generated TS return type for the service
Promise<{ data: Rpc.Stub<null>; error: {...}; }> 
| Promise<{ data: {...}; error: Rpc.Stub<null>; }>

// generated TS return type for the service
Promise<{ data: Rpc.Stub<null>; error: {...}; }> 
| Promise<{ data: {...}; error: Rpc.Stub<null>; }>

Btw, it appears to only use

Rpc.Stub<>

Rpc.Stub<>

for

null

null

and

undefined

undefined

. For all other types (number, boolean, custom types, etc) , the generated TS uses the actual type.

Workers service binding Typescript types uses Rpc.Stub<null>

Similar Threads

Workers service binding Typescript types uses Rpc.Stub<null>

Similar Threads

Similar Threads

Similar Threads