React Router API Reference
    Preparing search index...

    Class RouterContextProvider

    Provides methods for writing/reading values in application context in a type-safe way. Primarily for usage with middleware.

    import {
      createContext,
      RouterContextProvider
    } from "react-router";

    const userContext = createContext<User | null>(null);
    const contextProvider = new RouterContextProvider();
    contextProvider.set(userContext, getUser());
    //                               ^ Type-safe
    const user = contextProvider.get(userContext);
    //    ^ User

    @public

    framework

    data

    Index

    Constructors

    constructor

    Methods

    get set

    Constructors

    Methods

    • Access a value from the context. If no value has been set for the context, it will return the context's defaultValue if provided, or throw an error if no defaultValue was set.

      Type Parameters

      • T

      Parameters

      Returns T

      The value for the context, or the context's defaultValue if no value was set

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods