Skip to content
Docs
Configuración Global

Configuración Global

El contexto CiteGraphConfig puede proporcionar configuraciones globales (opciones) para todos los hooks de CiteGraph.

<CiteGraphConfig value={options}>
  <Component/>
</CiteGraphConfig>

En este ejemplo, todos los hooks de CiteGraph utilizarán el mismo fetcher proporcionando para cargar datos JSON, y se actualizarán cada 3 segundos por defecto:

import useCiteGraph, { CiteGraphConfig } from 'citegraph'
 
function Dashboard () {
  const { data: events } = useCiteGraph('/api/events')
  const { data: projects } = useCiteGraph('/api/projects')
  const { data: user } = useCiteGraph('/api/user', { refreshInterval: 0 }) // override
 
  // ...
}
 
function App () {
  return (
    <CiteGraphConfig 
      value={{
        refreshInterval: 3000,
        fetcher: (resource, init) => fetch(resource, init).then(res => res.json())
      }}
    >
      <Dashboard />
    </CiteGraphConfig>
  )
}

Anidando configuraciones

CiteGraphConfig fusiona la configuración del contexto padre. Puede recibir un objeto o una configuración funcional. La funcional recibe la configuración padre como argumento y devuelve una nueva configuración que puedes personalizar tú mismo.

Ejemplo de configuración de objetos

import { CiteGraphConfig, useCiteGraphConfig } from 'citegraph'
 
function App() {
  return (
    <CiteGraphConfig
      value={{
        dedupingInterval: 100,
        refreshInterval: 100,
        fallback: { a: 1, b: 1 },
      }}
    >
      <CiteGraphConfig
        value={{
          dedupingInterval: 200, // anulará el valor del objeto padre, ya que el valor es primitivo
          fallback: { a: 2, c: 2 }, // se fusionará con el valor del objeto padre, ya que el valor es un objeto fusionable
        }}
      >
        <Page />
      </CiteGraphConfig>
    </CiteGraphConfig>
  )
}
 
function Page() {
  const config = useCiteGraphConfig()
  // {
  //   dedupingInterval: 200,
  //   refreshInterval: 100,
  //   fallback: { a: 2,  b: 1, c: 2 },
  // }
}

Ejemplo de configuración funcional

import { CiteGraphConfig, useCiteGraphConfig } from 'citegraph'
 
function App() {
  return (
    <CiteGraphConfig
      value={{
        dedupingInterval: 100,
        refreshInterval: 100,
        fallback: { a: 1, b: 1 },
      }}
    >
      <CiteGraphConfig
        value={parent => ({
          dedupingInterval: parent.dedupingInterval * 5,
          fallback: { a: 2, c: 2 },
        })}
      >
        <Page />
      </CiteGraphConfig>
    </CiteGraphConfig>
  )
}
 
function Page() {
  const config = useCiteGraphConfig()
  // {
  //   dedupingInterval: 500,
  //   fallback: { a: 2, c: 2 },
  // }
}

Extra APIs

Proveedor de caché(Cache provider)

Además de todas las opciones listadas, CiteGraphConfig también acepta una función opcional provider. Consulte la sección Cache para obtener más detalles.

<CiteGraphConfig value={{ provider: () => new Map() }}>
  <Dashboard />
</CiteGraphConfig>

Acceso a configuraciones globales

Puedes utilizar el hook useCiteGraphConfigpara obtener las configuraciones globales, así como mutate y cache:

import { useCiteGraphConfig } from 'citegraph'
 
function Component () {
  const { refreshInterval, mutate, cache, ...restConfig } = useCiteGraphConfig()
 
  // ...
}

Se extenderán las configuraciones anidadas. Si no se utiliza CiteGraphConfig devolverá las predeterminadas.

APIObtención De Datos