{"id":21683740,"url":"https://github.com/open-eo/openeo-js-client","last_synced_at":"2025-04-12T07:51:36.063Z","repository":{"id":45333259,"uuid":"118762098","full_name":"Open-EO/openeo-js-client","owner":"Open-EO","description":"JavaScript and TypeScript client for the openEO API.","archived":false,"fork":false,"pushed_at":"2025-04-11T09:22:52.000Z","size":9620,"stargazers_count":16,"open_issues_count":14,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-11T11:31:37.674Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://open-eo.github.io/openeo-js-client/latest/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Open-EO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-24T12:25:18.000Z","updated_at":"2025-04-09T10:12:34.000Z","dependencies_parsed_at":"2023-11-10T11:33:32.548Z","dependency_job_id":"a525b52b-6dbb-44e6-9ea6-267e43d72649","html_url":"https://github.com/Open-EO/openeo-js-client","commit_stats":{"total_commits":319,"total_committers":7,"mean_commits":45.57142857142857,"dds":0.1849529780564263,"last_synced_commit":"3c83cf0a28e5026e413cf5c7fdd37d0e559e5609"},"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-EO%2Fopeneo-js-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-EO%2Fopeneo-js-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-EO%2Fopeneo-js-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-EO%2Fopeneo-js-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Open-EO","download_url":"https://codeload.github.com/Open-EO/openeo-js-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248537003,"owners_count":21120689,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T16:13:19.428Z","updated_at":"2025-04-12T07:51:36.056Z","avatar_url":"https://github.com/Open-EO.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openeo-js-client\n\nJavaScript/TypeScript client for the openEO API.\n\n* [Documentation](https://open-eo.github.io/openeo-js-client/latest/).\n\nThe version of this client is **2.7.0** and supports **openEO API versions 1.x.x**.\nLegacy versions are available as releases.\nSee the [CHANGELOG](CHANGELOG.md) for recent changes.\n\n## Usage\n\nThis library can run in node.js or any recent browser supporting ECMAScript 2017. This excludes Internet Explorer, but includes Edge \u003e= 15.\n\nAn *experimental* Typescript declaration file is available so that you can use the library also in your TypeScript projects.\n\n### Browser\n\nTo use it in a browser environment simply add the following code to your HTML file:\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/axios@1/dist/axios.min.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/oidc-client@1/dist/oidc-client.min.js\"\u003e\u003c/script\u003e \u003c!-- Only required if you'd like to enable authentication via OpenID Connect --\u003e\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/multihashes@3/src/index.min.js\"\u003e\u003c/script\u003e \u003c!-- Only required if you have checksums in the STAC metadata --\u003e\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@openeo/js-client@2/openeo.min.js\"\u003e\u003c/script\u003e\n```\n\n### NodeJS\n\nTo install it in a NodeJS environment run:\n`npm install @openeo/js-client`\n\nAfterwards, you can import the package:\n`const { OpenEO } = require('@openeo/js-client');`\n\n### TypeScript \n\nWarning: The TypeScript integration is still **experimental**! Please help us improve it by opening issues or pull requests.\n\nTo install it in a TypeScript environment run:\n`npm install @openeo/js-client`\n\nAfterwards, you can import the package:\n`import { OpenEO } from '@openeo/js-client';`\n\n### Examples\n\nIn the browser:\n* [Basic Discovery (promises)](examples/web/discovery.html)\n* [Run sync. job (async/await)](examples/web/workflow.html)\n\nIn Node.js:\n* [Basic Discovery (promises)](examples/node/discovery.js)\n\nIn Typescript:\n* [Basic Discovery (promises)](examples/typescript/discovery.ts)\n\nMore information can be found in the [documentation](https://open-eo.github.io/openeo-js-client/latest/).\n\n## Development\n\n![JS Client Tests](https://github.com/Open-EO/openeo-js-client/workflows/JS%20Client%20Tests/badge.svg)\n\nAlways make sure to adapt changes in the *.js files to the openeo.d.ts file.\nIf changes are larger you may want to run `npm run tsd` and regenerate the declaration file and cherry-pick your changes from there.\n\nGenerate a build: `npm run build` (generates `openeo.js` and `openeo.min.js`)\n\nGenerate the documentation to the `docs/` folder: `npm run docs`\n\nCheck against the coding guidelines: `npm run lint`\n\nRun tests:\n\n* `npm test` (all tests)\n* `npm test browser` (browser tests)\n* `npm test node` (node tests)\n* `npm test builder` (tests only the process builder)\n* `npm test earthengine` (full test suite using the Google Earth Engine back-end as server)\n\n# Contributions\n\nThe authors acknowledge the financial support for the development of this package during the H2020 project \"openEO\" (Oct 2017 to Sept 2020) by the European Union, funded by call EO-2-2017: EO Big Data Shift, under grant number 776242. We also acknowledge the financial support received from ESA for the project \"openEO Platform\" (Sept 2020 to Sept 2023).\n\nThis package received major contributions from the following organizations:\n\n[\u003cimg src=\"https://www.uni-muenster.de/imperia/md/images/allgemein/farbunabhaengig/wwu.svg\" alt=\"WWU Münster logo\" title=\"WWU Münster\" height=\"50\"\u003e](https://www.uni-muenster.de/) \u0026nbsp;\n[\u003cimg src=\"https://www.cubesatshop.com/wp-content/uploads/2017/05/logo.png\" alt=\"Solenix logo\" title=\"Solenix\" height=\"50\"\u003e](https://www.solenix.ch)\n[\u003cimg src=\"https://www.sinergise.com/sites/default/files/logo.png\" alt=\"Sinergise logo\" title=\"Sinergise\" height=\"50\"\u003e](https://www.sinergise.com)\n\n## Interactive Web Editor\n\nThere is an interactive web-based editor for coding using the openEO API,\nwhich is based on the JavaScript client.\nSee [https://github.com/Open-EO/openeo-web-editor](https://github.com/Open-EO/openeo-web-editor) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-eo%2Fopeneo-js-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-eo%2Fopeneo-js-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-eo%2Fopeneo-js-client/lists"}