Class ScalarApolloLink

Optional InternalgetMemoryInternals

Optional Readonly Internalleft

Optional Readonly Internalright

concat

• concat(...links: ApolloLink[]): ApolloLink

  Combines the link with other links into a single composed link.

  Parameters

  • ...links: ApolloLink[]

  Returns ApolloLink

  Example

  import { ApolloLink, HttpLink } from "@apollo/client";
  
  const previousLink = new ApolloLink((operation, forward) => {
    // Handle the request
  
    return forward(operation);
  });
  
  const link = previousLink.concat(
    link1,
    link2,
    new HttpLink({ uri: "http://localhost:4000/graphql" })
  );
  Copy

split

• split(
      test: (op: Operation) => boolean,
      left: ApolloLink,
      right?: ApolloLink,
  ): ApolloLink

  Concatenates a link that conditionally routes a request to different links.

  Parameters

  • test: (op: Operation) => boolean

    A predicate function that receives the current operation and returns a boolean indicating which link to execute. Returning true executes the left link. Returning false executes the right link.

  • left: ApolloLink

    The link that executes when the test function returns true.

  • Optionalright: ApolloLink

    The link that executes when the test function returns false. If the right link is not provided, the request is forwarded to the next link in the chain.

  Returns ApolloLink

  Example

  import { ApolloLink, HttpLink } from "@apollo/client";
  
  const previousLink = new ApolloLink((operation, forward) => {
    // Handle the request
  
    return forward(operation);
  });
  
  const link = previousLink.split(
    (operation) => operation.getContext().version === 1,
    new HttpLink({ uri: "http://localhost:4000/v1/graphql" }),
    new HttpLink({ uri: "http://localhost:4000/v2/graphql" })
  );
  Copy

Staticconcat

• concat(...links: ApolloLink[]): ApolloLink

  Combines multiple links into a single composed link.

  Parameters

  • ...links: ApolloLink[]

    The links to concatenate into a single link. Each link will execute in serial order.

  Returns ApolloLink

  Example

  const link = ApolloLink.concat(firstLink, secondLink, thirdLink);
  Copy

  Deprecated

  Use ApolloLink.from instead. ApolloLink.concat will be removed in a future major version.

Staticempty

• empty(): ApolloLink

  Creates a link that completes immediately and does not emit a result.

  Returns ApolloLink

  Example

  const link = ApolloLink.empty();
  Copy

Staticexecute

• execute(
      link: ApolloLink,
      request: Request,
      context: ExecuteContext,
  ): Observable<
      FormattedExecutionResult<Record<string, any>, Record<string, any>>,
  >

  Executes a GraphQL request against a link. The execute function begins the request by calling the request handler of the link.

  Parameters

  • link: ApolloLink

    The ApolloLink instance to execute the request.

  • request: Request

    The GraphQL request details, such as the query and variables.

  • context: ExecuteContext

    The execution context for the request, such as the client making the request.

  Returns Observable<FormattedExecutionResult<Record<string, any>, Record<string, any>>>

  Example

  const observable = ApolloLink.execute(link, { query, variables }, { client });
  
  observable.subscribe({
    next(value) {
      console.log("Received", value);
    },
    error(error) {
      console.error("Oops got error", error);
    },
    complete() {
      console.log("Request complete");
    },
  });
  Copy

Staticfrom

• from(links: ApolloLink[]): ApolloLink

  Composes multiple links into a single composed link that executes each provided link in serial order.

  Parameters

  • links: ApolloLink[]

    An array of ApolloLink instances or request handlers that are executed in serial order.

  Returns ApolloLink

  Example

  import { from, HttpLink, ApolloLink } from "@apollo/client";
  import { RetryLink } from "@apollo/client/link/retry";
  import MyAuthLink from "../auth";
  
  const link = ApolloLink.from([
    new RetryLink(),
    new MyAuthLink(),
    new HttpLink({ uri: "http://localhost:4000/graphql" }),
  ]);
  Copy

Staticsplit

• split(
      test: (op: Operation) => boolean,
      left: ApolloLink,
      right?: ApolloLink,
  ): ApolloLink

  Creates a link that conditionally routes a request to different links.

  Parameters

  • test: (op: Operation) => boolean

    A predicate function that receives the current operation and returns a boolean indicating which link to execute. Returning true executes the left link. Returning false executes the right link.

  • left: ApolloLink

    The link that executes when the test function returns true.

  • Optionalright: ApolloLink

    The link that executes when the test function returns false. If the right link is not provided, the request is forwarded to the next link in the chain.

  Returns ApolloLink

  Example

  import { ApolloLink, HttpLink } from "@apollo/client";
  
  const link = ApolloLink.split(
    (operation) => operation.getContext().version === 1,
    new HttpLink({ uri: "http://localhost:4000/v1/graphql" }),
    new HttpLink({ uri: "http://localhost:4000/v2/graphql" })
  );
  Copy