Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@planet/client
Advanced tools
A JavaScript client for Planet's imagery API. See the client API docs for detail on using the package.
The @planet/client
requires Node >= 0.12. Install the @planet/client
package npm
(which comes with Node).
npm install @planet/client
The @planet/client
package provides a library for use in your application and a planet
executable for command line use. See details on both below.
The @planet/client
package can be used in a Node based project or in the browser with a CommonJS module loader (like Browserify or Webpack).
It is also possible to load a standalone bundle of the library in a script tag. Without a module loader, this will create a global planet
object:
<script src="https://unpkg.com/@planet/client/dist/planet.js"></script>
This will redirect to the most recent release. To avoid the redirect, you can include a specific version number (e.g. https://unpkg.com/@planet/client@2.0.0/dist/planet.js).
The library requires a global Promise
implementation. This comes with Node >= 0.12 and modern browsers. To use @planet/client
in an environment without Promise
, you can use a polyfill.
See the API docs for detail on using the package.
To get set up, clone the repository and install the development dependencies:
git clone git@github.com:planetlabs/client.git
cd client
npm install
The tests are run in a browser and in Node. You can run the linter and all tests once with the following:
npm test
To start a file watcher that runs the linter and tests with any file changes:
npm start
With the npm start
task running, you can attach any number of browsers to the test server. Every time you attach a new browser, tests run in all browsers. To debug any failing test, visit the test runner debug page and open your development console.
The project docs are generated from templates in the doc
directory. The API docs are generated based on annotations in comments throughout the api
modules. You can build the docs with the following task:
npm run doc
You can view the doc output in the build/doc
directory.
Note - Building the docs requires Node >= 8.0.
Releases are published from the master branch. To cut a new minor release, do this:
npm version minor && git push --tags origin master && npm publish
The postpublish
script will update the hosted version of the docs.
Note - Publishing a release requires Node >= 8.0.
© Planet Labs, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
FAQs
A client for Planet's imagery API
We found that @planet/client demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.