Recomm.js

Recomm.js is a javascript library used to build recommendation systems, using Content-Based Filtering System.

Install

With npm

1npm i recomm.js

With yarn

1yarn add recomm.js

Usage

1. Import

   ES6

   1import { getSimilarPosts, SupportedLanguage } from "recomm.js";

   CommonJS

   1const { getSimilarPosts, SupportedLanguage } = require("recomm.js");

2. Get items

   1const results = getSimilarPosts(target, options);

Options

Name	Type	Description
items	Array of objects	Array of items
fields	Array of string	Array of fields
language	SupportedLanguage	Language of items
limit (optional)	Number (default: 10)	Items limit returned
orderBy (optional)	"DESC" || "ASC" (default: "DESC")	Order of returned items
returnFields (optional)	Array of string (default: [])	List of fields to be returned. By default, it returns all fields.

Supported Languages

• Arabic
• Danish
• Dutch
• English
• Finnish
• French
• German
• Greek
• Hungarian
• Italian
• Portuguese
• Romanian
• Russian
• Spanish
• Swedish
• Turkish

Examples

1const data = [
2  {
3    name: "Jenkins Cook",
4    gender: "male",
5    about: "Commodo Lorem ipsum dolore aute cupidatat.",
6    tags: ["ex", "labore"],
7    friends: [
8      {
9        id: 0,
10        name: "Marilyn Wyatt",
11      },
12      {
13        id: 1,
14        name: "Juana Jennings",
15      },
16    ],
17  },
18  {
19    name: "Elinor Rosales",
20    gender: "female",
21    about:
22      "Do ipsum fugiat excepteur anim sit pariatur sunt ea proident dolore id dolore consectetur. Fugiat amet tempor laborum esse sint tempor enim consectetur laborum fugiat pariatur commodo culpa sunt.",
23    tags: ["cupidatat"],
24    friends: [
25      {
26        id: 0,
27        name: "Molina Mckenzie",
28      },
29    ],
30  },
31  {
32    name: "Obrien Walter",
33    about: "In reprehenderit enim mollit proident aute anim ea.",
34    tags: ["proident", "proident", "voluptate"],
35    friends: [
36      {
37        id: 0,
38        name: "Francis Wilkerson",
39      },
40      {
41        id: 1,
42        name: "Sanders Adams",
43      },
44    ],
45  },
46];
47
48const target = {
49  name: "Stacey Dixon",
50  about:
51    "Incididunt minim ea ad anim. Nisi voluptate ut occaecat laborum sint ullamco mollit aliquip ea exercitation.",
52  tags: ["exercitation", "qui"],
53  friends: [
54    {
55      id: 0,
56      name: "Mable Pollard",
57    },
58    {
59      id: 1,
60      name: "Alisha Wagner",
61    },
62  ],
63};
64const options = {
65  fields: ["name", "about", "tags.+", "friends.+.name"],
66  items: data,
67  language: SupportedLanguage.ENGLISH,
68  returnFields: ["score"],
69};
70
71const results = getSimilarPosts(target, options);
72
73console.log(results);

Notes

The field "fields" uses the library nested-property, for get items inside objects