-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: adding typescript type for this package (#1)
* fix: adding typescript type for this package * Exclude types from coverage --------- Co-authored-by: Shadi Abu Hilal <[email protected]>
- Loading branch information
1 parent
43a00b6
commit b0bc767
Showing
8 changed files
with
96 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,8 @@ | |
"exclude": [ | ||
"**/*.cjs", | ||
"coverage/", | ||
"docs/" | ||
"docs/", | ||
"types/" | ||
], | ||
"reporter": [ | ||
"text", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{ | ||
"compilerOptions": { | ||
"allowJs": true, | ||
"declaration": true, | ||
"emitDeclarationOnly": true, | ||
"outDir": "./types" | ||
}, | ||
"include": ["./index.js"] | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
/** | ||
* Collection of query operators for Firestore queries. | ||
*/ | ||
export type QueryOperators = { | ||
/** | ||
* - Represents the less than operator (`<`). | ||
*/ | ||
lessThan: string; | ||
/** | ||
* - Represents the less than or equal to operator (`<=`). | ||
*/ | ||
lessThanOrEqualTo: string; | ||
/** | ||
* - Represents the equal to operator (`==`). | ||
*/ | ||
equalTo: string; | ||
/** | ||
* - Represents the greater than operator (`>`). | ||
*/ | ||
greaterThan: string; | ||
/** | ||
* - Represents the greater than or equal to operator (`>=`). | ||
*/ | ||
greaterThanOrEqualTo: string; | ||
/** | ||
* - Represents the not equal to operator (`!=`). | ||
*/ | ||
notEqualTo: string; | ||
/** | ||
* - Represents the array contains operator (`array-contains`). | ||
*/ | ||
arrayContains: string; | ||
/** | ||
* - Represents the array contains any operator (`array-contains-any`). | ||
*/ | ||
arrayContainsAny: string; | ||
/** | ||
* - Represents the "in" operator (`in`). | ||
*/ | ||
in: string; | ||
/** | ||
* - Represents the not in operator (`not-in`). | ||
*/ | ||
notIn: string; | ||
}; | ||
/** | ||
* Collection of query operators for Firestore queries. | ||
* | ||
* @typedef {Object} QueryOperators | ||
* @property {string} lessThan - Represents the less than operator (`<`). | ||
* @property {string} lessThanOrEqualTo - Represents the less than or equal to operator (`<=`). | ||
* @property {string} equalTo - Represents the equal to operator (`==`). | ||
* @property {string} greaterThan - Represents the greater than operator (`>`). | ||
* @property {string} greaterThanOrEqualTo - Represents the greater than or equal to operator (`>=`). | ||
* @property {string} notEqualTo - Represents the not equal to operator (`!=`). | ||
* @property {string} arrayContains - Represents the array contains operator (`array-contains`). | ||
* @property {string} arrayContainsAny - Represents the array contains any operator (`array-contains-any`). | ||
* @property {string} in - Represents the "in" operator (`in`). | ||
* @property {string} notIn - Represents the not in operator (`not-in`). | ||
*/ | ||
export const QueryOperators: Readonly<{ | ||
lessThan: "<"; | ||
lessThanOrEqualTo: "<="; | ||
equalTo: "=="; | ||
greaterThan: ">"; | ||
greaterThanOrEqualTo: ">="; | ||
notEqualTo: "!="; | ||
arrayContains: "array-contains"; | ||
arrayContainsAny: "array-contains-any"; | ||
in: "in"; | ||
notIn: "not-in"; | ||
}>; |