@sacochee/google-doc-types
v1.0.1
Published
Types TypeScript pour l'API Google Docs
Maintainers
Readme
🧾 TypeScript Types pour Google Docs JSON
Ce projet fournit une définition TypeScript presque complète du schéma JSON renvoyé par l’API Google Docs. Il est basé entièrement sur la documentation officielle de Google Docs.
🧪 Installation
Pour installer la bibliothèque, exécute la commande suivante dans ton terminal :
npm install @saccoche/google-doc-types🧪 Utilisation
Simplement des types.
import { Document, ParagraphElement, TextRun } from "@saccoche/google-doc-types";📦 Contenu
- Représentation typée du document Google Docs en TypeScript
- Structure hiérarchique :
Document,Body,Paragraph,Element,TextRun, etc. - Typage partiellement complet (voir section Limitations)
🚧 État du projet
Ce projet est partiellement terminé :
- La majorité des types sont définis
- Les types liés aux suggestions ne sont pas encore définis
- Certains champs ne sont pas explicitement marqués comme
undefinedou non, car la documentation de Google est parfois ambiguë à ce sujet - Plusieurs commentaires
// TODOmarquent les zones à compléter - Tous les types ne sont pas encore exportés depuis
type.d.ts
Ce projet est un work in progress. Toute contribution est la bienvenue !
🎯 Objectif
Fournir une base solide de typage pour la structure JSON retournée par l’API Google Docs, afin de faciliter son utilisation dans des projets TypeScript.
🤝 Contribuer
Tu veux participer ? Voici comment aider :
- Ajoute les types manquants (signalés avec
// TODO) - Corrige ou améliore les types existants
- Ouvre une issue pour signaler une erreur ou demander une clarification
Je serais ravi de recevoir vos retours ou contributions ! ✨
