sentence-examples

:ledger: A Node.js package that generates sentences for a given English word

Table of Contents

• Installation
• Methods
• Examples
• Author
• License

Installation

Using npm:

$ npm install sentence-examples

Using yarn:

$ yarn add sentence-examples

Methods

lookup(keyword, settings)

• keyword: The keyword that you want to browse some sentence examples for.

• settings: The object that contains additional settings for the browsing results (Optional).

  • limits: The maximum number of returned sentence examples, defaults to 0.

Examples

Import the package

NodeJS

const examples = require('sentence-examples');

ES6/ TypeScript

import examples from 'sentence-examples';

How to use

(async () => {
  try {
    const laptopExamples = await examples.lookup('laptop', {
      limits: 3,
    });

    const smartphoneExamples = await examples.lookup('smartphone', {
      limits: 5,
    });

    console.log(laptopExamples);
    /* [
      '"Keep eating," he said, glancing up from the laptop he set on the table before him.',
      'Her attention shifted to her laptop once more.',
      'Ingrid left and returned with her laptop and an iPad, sitting at the table with him.'
    ] */

    console.log(smartphoneExamples);
    /* [
      "Even though, at the time this article was written, the Apple iPhone was not available for purchase and use on the Verizon network, that doesn't mean that Verizon customers are without many other fantastic smartphone options.",
      "Going through the company's official lineup, you'll discover that the first Sprint Windows Mobile 6.5 smartphone also happens to be the only phone from the carrier that is currently powered by the new mobile operating system.",
      'This is basically the same smartphone as the Motorola DROID 2 with its touchscreen display and slide-out QWERTY keyboard, but this version has been outfitted with an array of Star Wars-themed accessories and customizations.',
      "If you like to watch movies, television shows, exercise videos, or anything else that combines video and sound using your iPad or other Bluetooth-enabled tablet or smartphone, you're sure to fall in love with this device.",
      'There are two types of websites for smartphones: those that work well on your smartphone when you use your Internet option and those that work to teach you about the ins and outs of your current phone or the phones you may be considering.',
      ...
    ] */
  } catch (error) {
    console.log(error);
  }
})();

Author

Tien-Dzung Nguyen (KutieKat)

License

MIT