Skip to content

Commit a531238

Browse files
feat!: rename FeatureClient decorator to OpenFeatureClient (#949)
<!-- Please use this template for your pull request. --> <!-- Please use the sections that you need and delete other sections --> ## This PR <!-- add the description of the PR here --> As discussed here [#750](#750 (comment)), renames `@FeatureClient` to `@OpenFeatureClient` which is possible since we merged #918. Signed-off-by: Lukas Reining <[email protected]>
1 parent e9d3ebc commit a531238

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

package-lock.json

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/nest/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,13 +137,13 @@ It is also possible to inject the default or domain scoped OpenFeature clients i
137137

138138
```ts
139139
import { Injectable } from '@nestjs/common';
140-
import { FeatureClient, Client } from '@openfeature/nestjs-sdk';
140+
import { OpenFeatureClient, Client } from '@openfeature/nestjs-sdk';
141141

142142
@Injectable()
143143
export class OpenFeatureTestService {
144144
constructor(
145-
@FeatureClient() private defaultClient: Client,
146-
@FeatureClient({ domain: 'my-domain' }) private scopedClient: Client,
145+
@OpenFeatureClient() private defaultClient: Client,
146+
@OpenFeatureClient({ domain: 'my-domain' }) private scopedClient: Client,
147147
) {}
148148

149149
public async getBoolean() {

packages/nest/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
"@nestjs/common": "^8.0.0 || ^9.0.0 || ^10.0.0",
4949
"@nestjs/core": "^8.0.0 || ^9.0.0 || ^10.0.0",
5050
"rxjs": "^6.0.0 || ^7.0.0 || 8.0.0",
51-
"@openfeature/server-sdk": ">=1.7.5"
51+
"@openfeature/server-sdk": ">=1.14.0"
5252
},
5353
"devDependencies": {
5454
"@nestjs/common": "^10.3.6",

packages/nest/src/feature.decorator.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ interface FeatureClientProps {
2626
* @param {FeatureClientProps} [props] The options for injecting the client.
2727
* @returns {PropertyDecorator & ParameterDecorator} The decorator function.
2828
*/
29-
export const FeatureClient = (props?: FeatureClientProps) => Inject(getOpenFeatureClientToken(props?.domain));
29+
export const OpenFeatureClient = (props?: FeatureClientProps) => Inject(getOpenFeatureClientToken(props?.domain));
3030

3131
/**
3232
* Options for injecting a feature flag into a route handler.

packages/nest/test/test-app.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { Controller, Get, Injectable, UseInterceptors } from '@nestjs/common';
22
import { Observable, map } from 'rxjs';
3-
import { BooleanFeatureFlag, ObjectFeatureFlag, NumberFeatureFlag, FeatureClient, StringFeatureFlag } from '../src';
3+
import { BooleanFeatureFlag, ObjectFeatureFlag, NumberFeatureFlag, OpenFeatureClient, StringFeatureFlag } from '../src';
44
import { Client, EvaluationDetails, FlagValue } from '@openfeature/server-sdk';
55
import { EvaluationContextInterceptor } from '../src';
66

77
@Injectable()
88
export class OpenFeatureTestService {
99
constructor(
10-
@FeatureClient() public defaultClient: Client,
11-
@FeatureClient({ domain: 'domainScopedClient' }) public domainScopedClient: Client,
10+
@OpenFeatureClient() public defaultClient: Client,
11+
@OpenFeatureClient({ domain: 'domainScopedClient' }) public domainScopedClient: Client,
1212
) {}
1313

1414
public async serviceMethod(flag: EvaluationDetails<FlagValue>) {

0 commit comments

Comments
 (0)