Descripción
Mangus es una biblioteca ligera que simplifica las interacciones con una API de Mangus a través de consultas GraphQL. Proporciona una clase Mangus
para la autenticación y una etiqueta de plantilla gql
para la creación conveniente de consultas GraphQL.
Instalación
Instala el paquete usando npm o yarn:
npm install mangus-client
o
yarn add mangus-client
Uso
1. Importar Mangus
Importa la clase Mangus
y la etiqueta de plantilla gql
desde tu proyecto:
import { Mangus, gql } from 'mangus-client';
2. Crear una instancia de Mangus
Instancia la clase Mangus
, proporcionando tus credenciales de API:
const mangus = new Mangus({
accessPublicKey: 'TU_CLAVE_PUBLICA',
accessPrivateKey: 'TU_CLAVE_SECRETA',
});
3. Ejecutar consultas GraphQL
- Define tu consulta GraphQL usando la etiqueta de plantilla
gql
para la interpolación de cadenas:
const myQuery = gql`
query MyQuery($userId: ID!) {
user(id: $userId) {
id
nombre
}
}
`;
- Usa el método
executeGql
de la instanciamangus
para ejecutar la consulta con variables:
async function getUser(userId) {
try {
const data = await mangus.executeGql(myQuery, { userId });
console.log(data);
} catch (error) {
console.error(error);
}
}
getUser('123'); // Reemplaza con el ID de usuario real
Referencia de la API
-
Clase Mangus
-
constructor(opts): Inicializa una nueva instancia de
Mangus
con las opciones de configuración proporcionadas.-
opts.accessPublicKey
(string): Tu clave pública de la API de Mangus. -
opts.accessPrivateKey
(string): Tu clave secreta de la API de Mangus.
-
-
executeGql(dataGql, variables) (función asíncrona): Ejecuta una consulta GraphQL contra la API de Mangus.
-
dataGql
(string): La cadena de consulta GraphQL. -
variables
(objeto, opcional): Un objeto que contiene variables para interpolar en la consulta. - Devuelve: Un objeto que contiene los datos de respuesta de GraphQL.
-
-
constructor(opts): Inicializa una nueva instancia de
-
Etiqueta de plantilla gql
- Una función de conveniencia para crear cadenas de consulta GraphQL con interpolación de variables. No realiza un análisis real en un AST a diferencia de
graphql-tag
.
- Una función de conveniencia para crear cadenas de consulta GraphQL con interpolación de variables. No realiza un análisis real en un AST a diferencia de
Soporte de TypeScript
El paquete exporta Mangus
por defecto para usar con la sintaxis de importación por defecto de TypeScript:
import Mangus from 'mangus-client';
Licencia
Este paquete está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.