Skip to content

Commit

Permalink
chore: rename BKTJsonValue in the comment to BKTValue
Browse files Browse the repository at this point in the history
  • Loading branch information
duyhungtnn committed Aug 21, 2024
1 parent cf33bad commit 7ac3c9a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions src/BKTClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export interface BKTClient {
numberVariation: (featureId: string, defaultValue: number) => number
booleanVariation: (featureId: string, defaultValue: boolean) => boolean
/**
* @deprecated use objectVariation(featureId: string, defaultValue: BKTJsonValue) instead.
* @deprecated use objectVariation(featureId: string, defaultValue: BKTValue) instead.
*/
jsonVariation: (featureId: string, defaultValue: BKTValue) => BKTValue
objectVariation: (featureId: string, defaultValue: BKTValue) => BKTValue
Expand Down Expand Up @@ -46,11 +46,11 @@ export interface BKTClient {
* Retrieves the evaluation details for a given feature based on its ID.
*
* @param featureId - The unique identifier for the feature.
* @param defaultValue - The default value to return if no result is found. This value should be of type `BKTJsonValue`.
* @param defaultValue - The default value to return if no result is found. This value should be of type `BKTValue`.
*
* @returns An object of type `BKTEvaluationDetail<BKTJsonValue>` containing the evaluation details.
* @returns An object of type `BKTEvaluationDetail<BKTValue>` containing the evaluation details.
*
* Note: The returned value will be either a BKTJsonObject or a BKTJsonArray. If no result is found, it will return the provided `defaultValue`, which can be of any type within `BKTJsonValue`.
* Note: The returned value will be either a BKTJsonObject or a BKTJsonArray. If no result is found, it will return the provided `defaultValue`, which can be of any type within `BKTValue`.
*/
objectVariationDetails: (
featureId: string,
Expand Down
2 changes: 1 addition & 1 deletion src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export { defineBKTUser } from './BKTUser'
export type { BKTClient } from './BKTClient'
export { getBKTClient, destroyBKTClient } from './BKTClient'
export type {
BKTValue as BKTJsonValue,
BKTValue,
BKTJsonArray,
BKTJsonObject,
BKTJsonPrimitive,
Expand Down

0 comments on commit 7ac3c9a

Please sign in to comment.