tskew


TypeScript interface to Kew Gardens botanical data services.

A complete TypeScript port of the Python pykew library, providing easy access to:

- IPNI (International Plant Names Index) - botanical nomenclatural data
- POWO (Plants of the World Online) - taxonomic and botanical information
- KPL (Kew Plant List) - plant list data

Installation

``bash
npm install tskew
`

🎉 Now available on npm: https://www.npmjs.com/package/tskew

Quick Start

`typescript
import { ipni, powo } from 'tskew';

// Simple string search
const results = ipni.search('Poa annua');
const plants = await results.take(5);
console.log(plants); // Real botanical data!

// Advanced search with terms
const oakTrees = powo.search({
[powo.Name.genus]: 'Quercus'
}, powo.Filters.accepted);

for await (const oak of oakTrees) {
console.log(${oak.name} - ${oak.family});
}
`

✨ Try it now: npm install tskew and run the code above!

📋 See example.js for a comprehensive working demonstration with live API results.

Usage

$3

`typescript
import { ipni, powo } from 'tskew';

// Simple string search
const results = ipni.search('Poa annua');
const powoResults = powo.search('Poa annua');

// Iterate through results
for await (const name of results) {
console.log(name);
}
`

$3

`typescript
import { ipni } from 'tskew';
// Terms are exported from the ipni module
const { Name, Filters } = ipni;

const query = {
[Name.genus]: 'Poa',
[Name.species]: 'annua',
[Name.author]: 'L.'
};

const results = ipni.search(query, Filters.familial);

// Get all results at once
const allResults = await results.all();

// Get just the first result
const firstResult = await results.first();

// Count results
const count = await results.size();
`

$3

`typescript
import { powo } from 'tskew';
// Terms are exported from the powo module
const { Name, Geography, Filters } = powo;

const query = {
[Name.genus]: 'Poa',
[Geography.distribution]: 'Africa'
};

const results = powo.search(query, Filters.accepted);

for await (const taxon of results) {
console.log(taxon.name, taxon.authors);
}
`

$3

`typescript
import { kpl } from 'tskew';

// Search all
const allResults = kpl.search();

// Search with query
const results = kpl.search('Poa');

for await (const taxon of results) {
console.log(taxon.name);
}
`

$3

`typescript
import { ipni, powo, kpl } from 'tskew';

// IPNI lookups
const name = await ipni.lookupName('320035-2');
const author = await ipni.lookupAuthor('12653-1');
const publication = await ipni.lookupPublication('1071-2');

// POWO lookup with additional fields
const taxon = await powo.lookup('123456', ['distribution', 'descriptions']);

// KPL lookup
const kplTaxon = await kpl.lookup('123456');
`

Complete API Reference

$3


- Name.added - "added"
- Name.author - "name author"
- Name.basionym - "basionym"
- Name.basionym_author - "basionym author"
- Name.bibliographic_reference - "bibliographic reference"
- Name.citation_type - "citation type"
- Name.collection_number - "collection number"
- Name.collectors - "collector team"
- Name.distribution - "distribution"
- Name.family - "family"
- Name.full_name - "full name"
- Name.genus - "genus"
- Name.in_powo - "in powo"
- Name.infrafamily - "infrafamily"
- Name.infragenus - "infragenus"
- Name.infraspecies - "infraspecies"
- Name.modified - "modified"
- Name.name_status - "name status"
- Name.published - "published"
- Name.published_in - "published in"
- Name.publishing_author - "publishing author"
- Name.rank - "rank"
- Name.scientific_name - "scientific name"
- Name.species - "species"
- Name.species_author - "species author"
- Name.version - "version"

$3

- Author.forename - "author forename"
- Author.full_name - "author name"
- Author.standard_form - "author std"
- Author.surname - "author surname"

$3

- Publication.standard_form - "publication std"
- Publication.bph_number - "bph number"
- Publication.date - "date"
- Publication.isbn - "isbn"
- Publication.issn - "issn"
- Publication.lc_number - "lc number"
- Publication.preceded_by - "preceded by"
- Publication.superceded_by - "superceded by"
- Publication.title - "publication title"
- Publication.tl2_author - "tl2 author"
- Publication.tl2_number - "tl2 number"

$3

- Filters.familial - "f_familial"
- Filters.infrafamilial - "f_infrafamilial"
- Filters.generic - "f_generic"
- Filters.infrageneric - "f_infrageneric"
- Filters.specific - "f_specific"

$3

- Name.full_name - "name"
- Name.common_name - "common name"
- Name.kingdom - "kingdom"
- Name.family - "family"
- Name.genus - "genus"
- Name.species - "species"
- Name.author - "author"

$3

- Characteristic.summary - "summary"
- Characteristic.appearance - "appearance"
- Characteristic.characteristic - "characteristic"
- Characteristic.flower - "flower"
- Characteristic.fruit - "fruit"
- Characteristic.leaf - "leaf"
- Characteristic.inflorescence - "inflorescence"
- Characteristic.seed - "seed"
- Characteristic.cloning - "cloning"
- Characteristic.use - "use"

$3

- Geography.distribution - "location"

$3

- Filters.accepted - "accepted_names"
- Filters.has_images - "has_images"
- Filters.families - "families_f"
- Filters.genera - "genus_f"
- Filters.species - "species_f"
- Filters.infraspecies - "infraspecific_f"

$3

- [Symbol.asyncIterator]() - Async iteration support
- all() - Get all results as array (respects default limit)
- first() - Get first result (efficient single-item fetch)
- size() - Get total count
- take(n) - Get first n results (efficient limited fetch)

$3

By default, SearchResult limits results to 10 items to improve performance. You can customize this:

`typescript
import { ipni } from 'tskew';

// Use default limit (10 items)
const results = ipni.search('Poa');
const plants = await results.all(); // Returns max 10 items

// Set custom default limit
const limitedResults = new SearchResult(ipni.api, 'Poa', null, 50);
const moreResults = await limitedResults.all(); // Returns max 50 items

// Get specific number efficiently
const fiveResults = await results.take(5); // Only fetches 5 items from API
``

Links

- 📦 npm package: https://www.npmjs.com/package/tskew
- 🐙 GitHub repository: https://github.com/crewbeatteam/tskew
- 🐍 Original Python library: https://github.com/RBGKew/pykew
- 🌱 Kew Gardens: https://www.kew.org/

Contributing

Issues and pull requests are welcome! See the GitHub repository for more information.

License

MIT