diff --git a/src/interfaces/json.interface.ts b/src/interfaces/json.interface.ts index 83f5438..468feaf 100644 --- a/src/interfaces/json.interface.ts +++ b/src/interfaces/json.interface.ts @@ -1,3 +1,9 @@ +/** + * Full text search algorithm + * ---- + * By [@pacifiquem](https://github.com/pacifiquem) and [@regisrex](https://github.com/regisrex) +*/ + export interface ParsedJSON { index: number value: string diff --git a/src/lib/parser.ts b/src/lib/parser.ts index 380eb9d..8a6a7bd 100644 --- a/src/lib/parser.ts +++ b/src/lib/parser.ts @@ -1,3 +1,10 @@ +/** + * Full text search algorithm + * ---- + * By [@pacifiquem](https://github.com/pacifiquem) and [@regisrex](https://github.com/regisrex) +*/ + + import { isArray, isJSON } from "valdie"; import { ParsedJSON } from "../interfaces/json.interface"; import { InvalidJSON } from "../utils/errors"; diff --git a/src/lib/search.ts b/src/lib/search.ts index df28bd0..e64cdf9 100644 --- a/src/lib/search.ts +++ b/src/lib/search.ts @@ -1,3 +1,9 @@ +/** + * Full text search algorithm + * ---- + * By [@pacifiquem](https://github.com/pacifiquem) and [@regisrex](https://github.com/regisrex) +*/ + import { ParsedJSON } from "../interfaces/json.interface"; import parser from "./parser"; diff --git a/src/utils/errors.ts b/src/utils/errors.ts index f73f5f8..72d68c2 100644 --- a/src/utils/errors.ts +++ b/src/utils/errors.ts @@ -1,3 +1,9 @@ +/** + * Full text search algorithm + * ---- + * By [@pacifiquem](https://github.com/pacifiquem) and [@regisrex](https://github.com/regisrex) +*/ + export class InvalidJSON extends Error { constructor(message: string) { super(message) diff --git a/src/utils/testDATA.ts b/src/utils/testDATA.ts index bcdcf3f..1fb97bd 100644 --- a/src/utils/testDATA.ts +++ b/src/utils/testDATA.ts @@ -1,3 +1,9 @@ +/** + * Full text search algorithm + * ---- + * By [@pacifiquem](https://github.com/pacifiquem) and [@regisrex](https://github.com/regisrex) +*/ + import { ParsedJSON } from "../interfaces/json.interface" export const validJsonObject = [{ diff --git a/test/parser.test.ts b/test/parser.test.ts index ad37ef8..ad2d2ba 100644 --- a/test/parser.test.ts +++ b/test/parser.test.ts @@ -1,3 +1,10 @@ +/** + * Full text search algorithm + * ---- + * By [@pacifiquem](https://github.com/pacifiquem) and [@regisrex](https://github.com/regisrex) +*/ + + import { describe, expect, it } from 'vitest'; import parser from "../src/lib/parser"; import { InvalidJSON } from '../src/utils/errors'; diff --git a/test/search.test.ts b/test/search.test.ts index 8e58f2f..72595b0 100644 --- a/test/search.test.ts +++ b/test/search.test.ts @@ -1,3 +1,10 @@ +/** + * Full text search algorithm + * ---- + * By [@pacifiquem](https://github.com/pacifiquem) and [@regisrex](https://github.com/regisrex) +*/ + + import { describe, expect, it } from 'vitest'; import search from '../src/lib/search';