Skip to content

Commit

Permalink
docs: jsdocs. add keywords to pkg.json
Browse files Browse the repository at this point in the history
  • Loading branch information
Tomas Kraus committed Apr 11, 2024
1 parent e168cdf commit 9b9c622
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 7 deletions.
6 changes: 4 additions & 2 deletions build/src/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
/**
* Tests if a given input string can match the simple pattern string.
* That pattern string is a very simple expression, much simpler than a RegExp
* That pattern string is a very simple expression, much simpler than a RegExp (see examples).
* @param patternStr a pattern an input string is matched with
* @param inputStr an input string
* @returns true if there is a match between the pattern and the input string, false otherwise
*
* @example
*
* // loose match (spaces and eols are insignificant)
* looseStringTest( 'abc', ' abc ') === true
* looseStringTest( '[1,2,3]', '[1, 2, 3]') === true
*
* // exact match
* // exact match (enclose the pattern in quotes)
* looseStringTest( '"abc"', ' abc ') === false
* looseStringTest( '"abc"', 'abc') === true
*
Expand Down
6 changes: 4 additions & 2 deletions build/src/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion build/src/index.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,15 @@
},
"keywords": [
"test",
"strimg",
"string",
"loose",
"match",
"output",
"console"
"console",
"compare",
"loose compare",
"string test",
"string compare"
],
"repository": {
"type": "git",
Expand Down

0 comments on commit 9b9c622

Please sign in to comment.