Skip to content

Commit ad239e5

Browse files
authored
Fix: typo in type definition file (#308)
* fix typos; add development details to readme * bump patch version
1 parent 15826ca commit ad239e5

File tree

6 files changed

+19
-6
lines changed

6 files changed

+19
-6
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ For full documentation visit [https://docs.flagsmith.com/clients/javascript/](ht
1515

1616
Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45cbd3eefb21cb0486) for details on our code of conduct, and the process for submitting pull requests to us.
1717

18+
### Development
19+
20+
1. Install Node >= v14.4
21+
1. Clone the repo
22+
1. Install dependencies: `npm install`
23+
1. Generate files: `npm run build`
24+
1. Make your code changes
25+
1. Ensure the project builds with `npm run build` and all tests are passing with `npm run test` before submitting a pull request
26+
1827
## Getting Help
1928

2029
If you encounter a bug or feature request we would like to hear about it. Before you submit an issue please search existing issues in order to prevent duplicates.

lib/flagsmith/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "flagsmith",
3-
"version": "9.2.0",
3+
"version": "9.2.1",
44
"description": "Feature flagging to support continuous development",
55
"main": "./index.js",
66
"module": "./index.mjs",

lib/react-native-flagsmith/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-native-flagsmith",
3-
"version": "9.2.0",
3+
"version": "9.2.1",
44
"description": "Feature flagging to support continuous development",
55
"main": "./index.js",
66
"repository": {

package.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"generatetypes": "curl https://raw.githubusercontent.com/Flagsmith/flagsmith/refs/heads/main/sdk/evaluation-context.json -o evaluation-context.json && npx quicktype -o evaluation-context.ts --src-lang schema --just-types --no-prefer-types --nice-property-names evaluation-context.json && rm evaluation-context.json",
1313
"postinstall": "patch-package",
1414
"prepublish": "npx in-publish && npm run build || echo",
15-
"test": "jest --env=jsdom"
15+
"test": "jest --env=jsdom",
16+
"checknodeversion": "npx ls-engines"
1617
},
1718
"repository": {
1819
"type": "git",
@@ -79,5 +80,8 @@
7980
"react-native-sse": "^1.1.0",
8081
"reconnecting-eventsource": "^1.5.0"
8182
},
82-
"types": "./index.d.ts"
83+
"types": "./index.d.ts",
84+
"engines": {
85+
"node": ">= 14.14"
86+
}
8387
}

test/types.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import {IFlagsmith} from '../types';
55
describe('Flagsmith Types', () => {
66

77
// The following tests will fail to compile if any of the types fail / expect-error has no type issues
8-
// Therefor all of the following ts-expect-errors and eslint-disable-lines are by design
8+
// Therefore all of the following ts-expect-errors and eslint-disable-lines are intentional
99
test('should allow supplying string generics to a flagsmith instance', async () => {
1010
const { flagsmith, } = getFlagsmith({ });
1111
const typedFlagsmith = flagsmith as IFlagsmith<"flag1"|"flag2">

types.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export type DynatraceObject = {
1010
}
1111

1212
export interface IFlagsmithFeature<Value = IFlagsmithValue> {
13-
id: numbers
13+
id: number;
1414
enabled: boolean;
1515
value: Value;
1616
}

0 commit comments

Comments
 (0)