Interface PAPIBuilder<Root>

Readonly root

build

• build(config?): PAPICaller<Root>

• Builds a new PAPICaller based on the current shape of the internal definition

  Parameters

  • Optional config: PAPIConfig

  Returns PAPICaller<Root>

delete

• delete<Resp>(resp): PAPIBuilder<Expand<Root & Record<typeof $DELETE, Record<typeof $response, Resp>>>>

• Define the response when sending a DELETE request to an endpoint

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response

  Parameters

  • resp: Resp

    Shape of the API's response

  Returns PAPIBuilder<Expand<Root & Record<typeof $DELETE, Record<typeof $response, Resp>>>>

  Example: Using the delete function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.delete({}));
  Copy

• delete<Resp, Delete>(resp, endpoint): PAPIBuilder<Expand<Root & Record<typeof $DELETE, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Delete>>>>>

• Define the response when sending a DELETE request to an endpoint, as well as provide information about alternate ways to request the API and/or alternate ways the API can respond

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response
  • Delete extends EndpointDefBuilderFn<EndpointDefBuilderOut<Delete>>

    Builder function that further defines specific behaviors of requesting this endpoint

  Parameters

  • resp: Resp

    Shape of the API's response
  • endpoint: Delete

    Builder function that further defines specific behaviors of requesting this endpoint

  Returns PAPIBuilder<Expand<Root & Record<typeof $DELETE, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Delete>>>>>

  Example: Using the delete function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.delete({}, $delete => $delete...));
  Copy

get

• get<Resp>(resp): PAPIBuilder<Expand<Root & Record<typeof $GET, Record<typeof $response, Resp>>>>

• Define the response when sending a GET request to an endpoint

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response

  Parameters

  • resp: Resp

    Shape of the API's response

  Returns PAPIBuilder<Expand<Root & Record<typeof $GET, Record<typeof $response, Resp>>>>

  Example: Using the get function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.get({}));
  Copy

• get<Resp, Get>(resp, endpoint): PAPIBuilder<Expand<Root & Record<typeof $GET, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Get>>>>>

• Define the response when sending a GET request to an endpoint, as well as provide information about alternate ways to request the API and/or alternate ways the API can respond

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response
  • Get extends EndpointDefBuilderFn<EndpointDefBuilderOut<Get>>

    Builder function that further defines specific behaviors of requesting this endpoint

  Parameters

  • resp: Resp

    Shape of the API's response
  • endpoint: Get

    Builder function that further defines specific behaviors of requesting this endpoint

  Returns PAPIBuilder<Expand<Root & Record<typeof $GET, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Get>>>>>

  Example: Using the get function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.get({}, $get => $get...));
  Copy

patch

• patch<Resp>(resp): PAPIBuilder<Expand<Root & Record<typeof $PATCH, Record<typeof $response, Resp>>>>

• Define the response when sending a PATCH request to an endpoint

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response

  Parameters

  • resp: Resp

    Shape of the API's response

  Returns PAPIBuilder<Expand<Root & Record<typeof $PATCH, Record<typeof $response, Resp>>>>

  Example: Using the patch function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.patch({}));
  Copy

• patch<Resp, Patch>(resp, endpoint): PAPIBuilder<Expand<Root & Record<typeof $PATCH, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Patch>>>>>

• Define the response when sending a Patch request to an endpoint, as well as provide information about alternate ways to request the API and/or alternate ways the API can respond

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response
  • Patch extends EndpointDefBuilderFn<EndpointDefBuilderOut<Patch>>

    Builder function that further defines specific behaviors of requesting this endpoint

  Parameters

  • resp: Resp

    Shape of the API's response
  • endpoint: Patch

    Builder function that further defines specific behaviors of requesting this endpoint

  Returns PAPIBuilder<Expand<Root & Record<typeof $PATCH, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Patch>>>>>

  Example: Using the patch function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.patch({}, $patch => $patch...));
  Copy

path

• path<const PathName, Path>(pathname, path): PAPIBuilder<Expand<Root & Record<PathName, APIDefBuilderFnOut<Path>>>>

• Define a new path segment of an API. A path segment is each section of an API's endpoint URL separated by a / that has a fixed value -- for instance, in the fake API https://fake.api/v2/user/:userId, the values of v2 and user are path segments

  A path segment's definition may contain other paths/shareds/slugs as well as endpoint definitions.

  Type Parameters

  • const PathName extends string

    Path segment of the url
  • Path extends APIDefBuilderFn<APIDefBuilderFnOut<Path>>

    Builder function that further defines the shape of the path

  Parameters

  • pathname: PathName

    Path segment of the url
  • path: Path

    Builder function that further defines the shape of the path

  Returns PAPIBuilder<Expand<Root & Record<PathName, APIDefBuilderFnOut<Path>>>>

  Example: Using the path function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user...);
  Copy

post

• post<Resp>(resp): PAPIBuilder<Expand<Root & Record<typeof $POST, Record<typeof $response, Resp>>>>

• Define the response when sending a POST request to an endpoint

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response

  Parameters

  • resp: Resp

    Shape of the API's response

  Returns PAPIBuilder<Expand<Root & Record<typeof $POST, Record<typeof $response, Resp>>>>

  Example: Using the post function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.post({}));
  Copy

• post<Resp, Post>(resp, endpoint): PAPIBuilder<Expand<Root & Record<typeof $POST, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Post>>>>>

• Define the response when sending a POST request to an endpoint, as well as provide information about alternate ways to request the API and/or alternate ways the API can respond

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response
  • Post extends EndpointDefBuilderFn<EndpointDefBuilderOut<Post>>

    Builder function that further defines specific behaviors of requesting this endpoint

  Parameters

  • resp: Resp

    Shape of the API's response
  • endpoint: Post

    Builder function that further defines specific behaviors of requesting this endpoint

  Returns PAPIBuilder<Expand<Root & Record<typeof $POST, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Post>>>>>

  Example: Using the post function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.post({}, $post => $post...));
  Copy

put

• put<Resp>(resp): PAPIBuilder<Expand<Root & Record<typeof $PUT, Record<typeof $response, Resp>>>>

• Define the response when sending a PUT request to an endpoint

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response

  Parameters

  • resp: Resp

    Shape of the API's response

  Returns PAPIBuilder<Expand<Root & Record<typeof $PUT, Record<typeof $response, Resp>>>>

  Example: Using the put function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.put({}));
  Copy

• put<Resp, Put>(resp, endpoint): PAPIBuilder<Expand<Root & Record<typeof $PUT, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Put>>>>>

• Define the response when sending a PUT request to an endpoint, as well as provide information about alternate ways to request the API and/or alternate ways the API can respond

  Type Parameters

  • Resp extends GenericData

    Shape of the API's response
  • Put extends EndpointDefBuilderFn<EndpointDefBuilderOut<Put>>

    Builder function that further defines specific behaviors of requesting this endpoint

  Parameters

  • resp: Resp

    Shape of the API's response
  • endpoint: Put

    Builder function that further defines specific behaviors of requesting this endpoint

  Returns PAPIBuilder<Expand<Root & Record<typeof $PUT, Expand<Record<typeof $response, Resp> & EndpointDefBuilderOut<Put>>>>>

  Example: Using the put function

  papi('https://jsonplaceholder.typicode.com')
    .path('user', user => user.put({}, $put => $put...));
  Copy

shared

• shared<const Paths, Shared>(paths, shared): PAPIBuilder<Expand<Root & Record<Paths[number], APIDefBuilderFnOut<Shared>>>>

• Define a new shared segment of an API. A shared segment is each section of an API's endpoint URL separated by a / that can represent multiple values from a selected set -- for instance, in the fake API https://fake.api/v2/categories/:category, where only the values "comments", "photos", and "users" are valid, the value of :category is a shared segment

  A shared segment's definition may contain other paths/shareds/slugs as well as endpoint definitions.

  Type Parameters

  • const Paths extends string[]
  • Shared extends APIDefBuilderFn<APIDefBuilderFnOut<Shared>>

    Builder function that further defines the shape of the shared segment

  Parameters

  • paths: Paths

    List of paths represented by the shared segment
  • shared: Shared

    Builder function that further defines the shape of the shared segment

  Returns PAPIBuilder<Expand<Root & Record<Paths[number], APIDefBuilderFnOut<Shared>>>>

  Example: Using the shared function

  papi('https://jsonplaceholder.typicode.com')
    .shared(userId => userId...);
  Copy

slug

• slug<Slug>(slug): PAPIBuilder<Expand<Root & Record<typeof $slug, APIDefBuilderFnOut<Slug>>>>

• Define a new slug segment of an API. A slug segment is each section of an API's endpoint URL separated by a / that can represent multiple values -- for instance, in the fake API https://fake.api/v2/user/:userId, the value of :userId is a slug segment

  A slug segment's definition may contain other paths/shareds/slugs as well as endpoint definitions.

  Type Parameters

  • Slug extends APIDefBuilderFn<APIDefBuilderFnOut<Slug>>

    Builder function that further defines the shape of the slug

  Parameters

  • slug: Slug

    Builder function that further defines the shape of the slug

  Returns PAPIBuilder<Expand<Root & Record<typeof $slug, APIDefBuilderFnOut<Slug>>>>

  Example: Using the slug function

  papi('https://jsonplaceholder.typicode.com')
    .slug(userId => userId...);
  Copy