smart-word-generator
v1.1.1
Published
Generate specific words using AI (Datamuse API) depending on your needs. Fully typed with TypeScript.
Maintainers
Readme
Description
Smart word generator is a library for generating words using artificial intelligence via the Datamuse API. It allows you to find words with similar meanings, sounds, spellings, and various other relationships.
Now fully rewritten in TypeScript for better developer experience and type safety!
Features
- Type-Safe: Written in TypeScript with full type definitions.
- Unified API: All functions accept a consistent options object.
- Rich Relationships: Generate synonyms, antonyms, rhymes, and more.
- Flexible Filtering: distinct parts of speech, topics, and patterns.
Installation
npm install smart-word-generatorUsage
Import the functions you need from the package:
import {
generateWordMeansLike,
generateRhyme,
generateSynonym,
generateAntonym,
generateWordSoundsLike
} from "smart-word-generator";Options Object
All generator functions accept an optional options object:
interface GeneratorOptions {
transformToArray?: boolean; // Return string[] if true, else detailed object[]
partOfSpeech?: 'n' | 'v' | 'adj' | 'adv';
topics?: string; // Context topics
startWith?: string; // Filter words starting with...
endWith?: string; // Filter words ending with...
max?: number; // Max results
}Examples
Find words with similar meaning
const words = await generateWordMeansLike("great", {
partOfSpeech: "adj",
transformToArray: true,
max: 5
});
console.log(words);
// Output: ['big', 'huge', 'vast', 'large', 'grand']Find Rhymes
const rhymes = await generateRhyme("cat", { max: 5, transformToArray: true });
console.log(rhymes);
// Output: ['hat', 'bat', 'rat', 'mat', 'fat']Find Synonyms
await generateSynonym("happy");Find Antonyms
await generateAntonym("hot");Find Words Sounding Like
await generateWordSoundsLike("flower");Find Adjectives describing a Noun
// Find adjectives often used to describe 'ocean'
await generateAdjectiveForNoun("ocean");Find Nouns described by an Adjective
// Find nouns often described as 'blue'
await generateNounForAdjective("blue");API List
generateWordMeansLike(word, options)generateWordSoundsLike(word, options)generateWordSpelledLike(word, options)generateRhyme(word, options)generateSynonym(word, options)generateAntonym(word, options)generateAdjectiveForNoun(word, options)generateNounForAdjective(word, options)generateWordHasLeftContext(word, options)generateWordHasRightContext(word, options)generateRelatedWord(word, relationCode, options)
License
ISC
