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

1.0.4 • Public • Published

keyword-farmer

Overview

If you use this, you are a farmer.
Build and harvest a farm with the crops you want.
Like a farmer tending his farm, create keywords
It will provide you mock keywords data.

Installation

npm install keyword-farmer

Example

import { useKeywordFarm } from 'keyword-farmer';

const { create } =  useKeywordFarm();

create(); 
// output: 'sweater' | 'iphone 14 pro' | 'shirt' ...

Options

interface Config {
  lang?: 'en' | 'kr'
  length?: number | { min?: number, max?: number }
  excludeSpaces?: boolean
  specialKeywords?: 'only' | 'mixed' | 'combine'
}
  • lang - This is the language of keywords. Currently supports en kr, default is en
  • length - Limit the length of keywords to be handled.
  • excludeSpaces - Whether to exclude spaces in words. The default is true (inclusive).
  • specialKeywords - This is an option to handle special characters (mutations). Special characters are Unicode special characters.
    • only - The keyword list consists only of specialKeywords. Also other options are ignored
    • mixed - Consists of general keywords and specialKeywords
    • combine - keyword characters contain specialKeywords combined in random positions.

Package Sidebar

Install

npm i keyword-farmer

Weekly Downloads

1

Version

1.0.4

License

ISC

Unpacked Size

72 kB

Total Files

7

Last publish

Collaborators

  • kis0421