mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-08-12 21:10:23 +00:00
ldclient-js: Provides its own types (#22387)
This commit is contained in:
Andy
@@ -408,6 +408,12 @@
|
||||
"sourceRepoURL": "https://github.com/elitechance/lambda-phi",
|
||||
"asOfVersion": "1.0.1"
|
||||
},
|
||||
{
|
||||
"libraryName": "ldclient-js",
|
||||
"typingsPackageName": "ldclient-js",
|
||||
"sourceRepoURL": "https://github.com/launchdarkly/js-client",
|
||||
"asOfVersion": "1.1.11"
|
||||
},
|
||||
{
|
||||
"libraryName": "left-pad",
|
||||
"typingsPackageName": "left-pad",
|
||||
|
||||
Vendored
-238
@@ -1,238 +0,0 @@
|
||||
// Type definitions for ldclient-js v1.1.2
|
||||
// Project: https://github.com/launchdarkly/js-client
|
||||
// Definitions by: Isaac Sukin <https://isaacsukin.com>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
/**
|
||||
* The LaunchDarkly JavaScript client interfaces.
|
||||
*
|
||||
* Documentation: http://docs.launchdarkly.com/docs/js-sdk-reference
|
||||
*/
|
||||
declare namespace LaunchDarkly {
|
||||
/**
|
||||
* The names of events to which users of the client can subscribe.
|
||||
*/
|
||||
export type LDEventName = 'ready' | 'change';
|
||||
|
||||
/**
|
||||
* The types of values a feature flag can have.
|
||||
*
|
||||
* Flags can have any JSON-serializable value.
|
||||
*/
|
||||
export type LDFlagValue = any;
|
||||
|
||||
/**
|
||||
* A map of feature flags from their keys to their values.
|
||||
*/
|
||||
export type LDFlagSet = {
|
||||
[key: string]: LDFlagValue,
|
||||
};
|
||||
|
||||
/**
|
||||
* A map of feature flag keys to objects holding changes in their values.
|
||||
*/
|
||||
export type LDFlagChangeset = {
|
||||
[key: string]: {
|
||||
current: LDFlagValue,
|
||||
previous: LDFlagValue,
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
* The parameters required to (un)subscribe to/from LaunchDarkly events.
|
||||
*
|
||||
* See LDClient#on and LDClient#off.
|
||||
*/
|
||||
type LDEventSignature = (
|
||||
key: LDEventName,
|
||||
callback: (current?: LDFlagValue | LDFlagChangeset, previous?: LDFlagValue) => void,
|
||||
context?: any
|
||||
) => void;
|
||||
|
||||
/**
|
||||
* LaunchDarkly initialization options.
|
||||
*/
|
||||
export interface LDOptions {
|
||||
/**
|
||||
* The signed user key for Secure Mode.
|
||||
*
|
||||
* @see http://docs.launchdarkly.com/docs/js-sdk-reference#secure-mode
|
||||
*/
|
||||
hash: string;
|
||||
|
||||
/**
|
||||
* The initial set of flags to use until the remote set is retrieved.
|
||||
*
|
||||
* If "localStorage" is specified, the flags will be saved locally and
|
||||
* retrieved from storage. Alternatively an LDFlagSet can be specified
|
||||
* which will be used as the initial source of flag values.
|
||||
*/
|
||||
bootstrap?: 'localStorage' | LDFlagSet;
|
||||
}
|
||||
|
||||
/**
|
||||
* A LaunchDarkly user object.
|
||||
*/
|
||||
export interface LDUser {
|
||||
/**
|
||||
* A unique string identifying a user.
|
||||
*/
|
||||
key: string;
|
||||
|
||||
/**
|
||||
* The user's name.
|
||||
*
|
||||
* You can search for users on the User page by name.
|
||||
*/
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* The user's first name.
|
||||
*/
|
||||
firstName?: string;
|
||||
|
||||
/**
|
||||
* The user's last name.
|
||||
*/
|
||||
lastName?: string;
|
||||
|
||||
/**
|
||||
* The user's email address.
|
||||
*
|
||||
* If an `avatar` URL is not provided, LaunchDarkly will use Gravatar
|
||||
* to try to display an avatar for the user on the Users page.
|
||||
*/
|
||||
email?: string;
|
||||
|
||||
/**
|
||||
* An absolute URL to an avatar image for the user.
|
||||
*/
|
||||
avatar?: string;
|
||||
|
||||
/**
|
||||
* The user's IP address.
|
||||
*
|
||||
* If you provide an IP, LaunchDarkly will use a geolocation service to
|
||||
* automatically infer a `country` for the user, unless you've already
|
||||
* specified one.
|
||||
*/
|
||||
ip?: string;
|
||||
|
||||
/**
|
||||
* The country associated with the user.
|
||||
*/
|
||||
country?: string;
|
||||
|
||||
/**
|
||||
* Whether to show the user on the Users page in LaunchDarkly.
|
||||
*/
|
||||
anonymous?: boolean;
|
||||
|
||||
/**
|
||||
* Any additional attributes associated with the user.
|
||||
*/
|
||||
custom?: {
|
||||
[key: string]: string | boolean | number | Array<string | boolean | number>,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* The LaunchDarkly client's instance interface.
|
||||
*
|
||||
* @see http://docs.launchdarkly.com/docs/js-sdk-reference
|
||||
*/
|
||||
export interface LDClient {
|
||||
/**
|
||||
* Identifies a user to LaunchDarkly.
|
||||
*
|
||||
* This only needs to be called if the user changes identities because
|
||||
* normally the user's identity is set during client initialization.
|
||||
*
|
||||
* @param user
|
||||
* A map of user options. Must contain at least the `key` property
|
||||
* which identifies the user.
|
||||
* @param hash
|
||||
* The signed user key for Secure Mode; see
|
||||
* http://docs.launchdarkly.com/docs/js-sdk-reference#secure-mode
|
||||
* @param onDone
|
||||
* A callback to invoke after the user is identified.
|
||||
*/
|
||||
identify: (user: LDUser, hash?: string, onDone?: () => void) => void;
|
||||
|
||||
/**
|
||||
* Retrieves a flag's value.
|
||||
*
|
||||
* @param key
|
||||
* The key of the flag for which to retrieve the corresponding value.
|
||||
* @param defaultValue
|
||||
* The value to use if the flag is not available (for example, if the
|
||||
* user is offline or a flag is requested that does not exist).
|
||||
*
|
||||
* @returns
|
||||
* The flag's value.
|
||||
*/
|
||||
variation: (key: string, defaultValue?: LDFlagValue) => LDFlagValue;
|
||||
|
||||
/**
|
||||
* Registers an event listener.
|
||||
*
|
||||
* @param key
|
||||
* The name of the event for which to listen. This can be "ready",
|
||||
* "change", or "change:FLAG-KEY".
|
||||
* @param callback
|
||||
* The function to execute when the event fires. For the "change"
|
||||
* event, the callback receives one parameter: an LDFlagChangeset
|
||||
* describing the changes. For "change:FLAG-KEY" events, the callback
|
||||
* receives two parameters: the current (new) value and the previous
|
||||
* value of the relevant flag.
|
||||
* @param context
|
||||
* The "this" context to use for the callback.
|
||||
*/
|
||||
on: LDEventSignature;
|
||||
|
||||
/**
|
||||
* Deregisters an event listener.
|
||||
*
|
||||
* @param key
|
||||
* The name of the event for which to stop listening. This can be
|
||||
* "ready", "change", or "change:FLAG-KEY".
|
||||
* @param callback
|
||||
* The function to deregister.
|
||||
* @param context
|
||||
* The "this" context for the callback.
|
||||
*/
|
||||
off: LDEventSignature;
|
||||
|
||||
/**
|
||||
* Track page events to use in goals or A/B tests.
|
||||
*
|
||||
* LaunchDarkly automatically tracks pageviews and clicks that are
|
||||
* specified in the Goals section of their dashboard. This can be used
|
||||
* to track custom goals or other events that do not currently have
|
||||
* goals.
|
||||
*
|
||||
* @param key
|
||||
* The event to record.
|
||||
* @param data
|
||||
* Additional information to associate with the event.
|
||||
*/
|
||||
track: (key: string, data?: any) => void;
|
||||
|
||||
/**
|
||||
* Returns a map of all available flags to the current user's values.
|
||||
*/
|
||||
allFlags: () => LDFlagSet;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* The LaunchDarkly static global.
|
||||
*/
|
||||
declare var LDClient: {
|
||||
initialize: (
|
||||
key: string,
|
||||
user: LaunchDarkly.LDUser,
|
||||
options?: LaunchDarkly.LDOptions
|
||||
) => LaunchDarkly.LDClient;
|
||||
};
|
||||
@@ -1,30 +0,0 @@
|
||||
// Implicitly calls LDClient#identify
|
||||
const ldClient = LDClient.initialize(
|
||||
'ENV KEY',
|
||||
{
|
||||
key: 'USER KEY',
|
||||
name: 'USER NAME',
|
||||
custom: {
|
||||
'CUSTOM ATTRIBUTE': ['CUSTOM VALUE'],
|
||||
},
|
||||
},
|
||||
{
|
||||
hash: 'SECURE USER HASH',
|
||||
}
|
||||
);
|
||||
|
||||
ldClient.on('ready', () => {
|
||||
const defaultValue = false;
|
||||
ldClient.variation('FLAG-KEY', defaultValue);
|
||||
console.log('All flag values:', ldClient.allFlags());
|
||||
});
|
||||
|
||||
function changeCallback(changes: LaunchDarkly.LDFlagChangeset) {
|
||||
console.log('Flags changed:', changes);
|
||||
}
|
||||
|
||||
ldClient.on('change', changeCallback);
|
||||
|
||||
document.getElementById('disable-change-tracking')!.addEventListener('click', () => {
|
||||
ldClient.off('change', changeCallback);
|
||||
});
|
||||
@@ -1,24 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6",
|
||||
"dom"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"strictFunctionTypes": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"ldclient-js-tests.ts"
|
||||
]
|
||||
}
|
||||
@@ -1,79 +0,0 @@
|
||||
{
|
||||
"extends": "dtslint/dt.json",
|
||||
"rules": {
|
||||
"adjacent-overload-signatures": false,
|
||||
"array-type": false,
|
||||
"arrow-return-shorthand": false,
|
||||
"ban-types": false,
|
||||
"callable-types": false,
|
||||
"comment-format": false,
|
||||
"dt-header": false,
|
||||
"eofline": false,
|
||||
"export-just-namespace": false,
|
||||
"import-spacing": false,
|
||||
"interface-name": false,
|
||||
"interface-over-type-literal": false,
|
||||
"jsdoc-format": false,
|
||||
"max-line-length": false,
|
||||
"member-access": false,
|
||||
"new-parens": false,
|
||||
"no-any-union": false,
|
||||
"no-boolean-literal-compare": false,
|
||||
"no-conditional-assignment": false,
|
||||
"no-consecutive-blank-lines": false,
|
||||
"no-construct": false,
|
||||
"no-declare-current-package": false,
|
||||
"no-duplicate-imports": false,
|
||||
"no-duplicate-variable": false,
|
||||
"no-empty-interface": false,
|
||||
"no-for-in-array": false,
|
||||
"no-inferrable-types": false,
|
||||
"no-internal-module": false,
|
||||
"no-irregular-whitespace": false,
|
||||
"no-mergeable-namespace": false,
|
||||
"no-misused-new": false,
|
||||
"no-namespace": false,
|
||||
"no-object-literal-type-assertion": false,
|
||||
"no-padding": false,
|
||||
"no-redundant-jsdoc": false,
|
||||
"no-redundant-jsdoc-2": false,
|
||||
"no-redundant-undefined": false,
|
||||
"no-reference-import": false,
|
||||
"no-relative-import-in-test": false,
|
||||
"no-self-import": false,
|
||||
"no-single-declare-module": false,
|
||||
"no-string-throw": false,
|
||||
"no-unnecessary-callback-wrapper": false,
|
||||
"no-unnecessary-class": false,
|
||||
"no-unnecessary-generics": false,
|
||||
"no-unnecessary-qualifier": false,
|
||||
"no-unnecessary-type-assertion": false,
|
||||
"no-useless-files": false,
|
||||
"no-var-keyword": false,
|
||||
"no-var-requires": false,
|
||||
"no-void-expression": false,
|
||||
"no-trailing-whitespace": false,
|
||||
"object-literal-key-quotes": false,
|
||||
"object-literal-shorthand": false,
|
||||
"one-line": false,
|
||||
"one-variable-per-declaration": false,
|
||||
"only-arrow-functions": false,
|
||||
"prefer-conditional-expression": false,
|
||||
"prefer-const": false,
|
||||
"prefer-declare-function": false,
|
||||
"prefer-for-of": false,
|
||||
"prefer-method-signature": false,
|
||||
"prefer-template": false,
|
||||
"radix": false,
|
||||
"semicolon": false,
|
||||
"space-before-function-paren": false,
|
||||
"space-within-parens": false,
|
||||
"strict-export-declare-modifiers": false,
|
||||
"trim-file": false,
|
||||
"triple-equals": false,
|
||||
"typedef-whitespace": false,
|
||||
"unified-signatures": false,
|
||||
"void-return": false,
|
||||
"whitespace": false
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user