Client interface

Shape of a Rest Level Client

Properties

path

This method will be used to send request that would check the path to provide strong types. When used by the codegen this type gets overriden wit the generated types. For example:

export type MyClient = Client & {
   path: Routes;
}
pathUnchecked

This method allows arbitrary paths and doesn't provide strong types

pipeline

The pipeline used by this client to make requests

Property Details

path

This method will be used to send request that would check the path to provide strong types. When used by the codegen this type gets overriden wit the generated types. For example:

export type MyClient = Client & {
   path: Routes;
}
path: Function

Property Value

Function

pathUnchecked

This method allows arbitrary paths and doesn't provide strong types

pathUnchecked: PathUnchecked

Property Value

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value