Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.05 KB

README.md

File metadata and controls

30 lines (21 loc) · 1.05 KB

datagouv-ts

NPM Version

Utilitaire pour la publication de données sur datagouv (data.gouv.fr).

Cet outil permet de:

  • getDatasetMetadata: obtenir les métadonnées d'un jeu de données
  • createResourceRemote: créer une resource distante (remote) à partir de son URL
  • createResourceFromFile: créer une resource à partir d'un fichier
  • deleteResource: supprimer une resource à partir de son id
  • updateResource: mettre à jour les propriétés d'une resource (description, title et url)

Des types ont également été créés pour manipuler simplement les objets datagouv:

  • DatagouvResourceCustom représente une resource datagouv

Usage

Dans un fichier Typescript:

import {DatagouvResourceCustom, Datagouv} from "datagouv-ts";

async function main(){
    const resourceCreated: DatagouvResourceCustom = await Datagouv.createResourceFromFile(...);
    console.log("Resource just created: "+resourceCreated.title)
}

main();