verdantly
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

Verdantly Node.js Client

The official Node.js client for accessing plant variety and species data from the Verdantly API.


Installation

npm install verdantly

Getting Started

You'll need a valid API key from RapidAPI.

import { VerdantlyClient } from 'verdantly';

const client = new VerdantlyClient({ apiKey: 'your-api-key' });

Example Usage

const results = await client.searchPlantVarietiesByFilter({
  category: "fruit",
  waterRequirement: "low"
});

for (const plant of results.data) {
  console.log(plant.name);
}

More examples available in examples/starter.


Supported Endpoints

  • searchPlantVarietiesByName(query: string, page?: number)
  • searchPlantVarietiesByFilter(filters: object, page?: number)
  • searchPlantSpeciesByName(query: string, page?: number)
  • searchPlantSpeciesByFilter(filters: object, page?: number)

TypeScript Support

All client responses are fully typed, with built-in TypeScript definitions included in the package.


Project Structure

  • src/ — client source code
  • examples/starter/ — starter project
  • dist/ — compiled output (after build)

License

MIT © Verdantly

Package Sidebar

Install

npm i verdantly

Weekly Downloads

7

Version

1.0.3

License

MIT

Unpacked Size

16.4 kB

Total Files

6

Last publish

Collaborators

  • verdantly