Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
35953b7
1st step: move SplitIO namespace definition from Browser SDK to JS-Co…
EmilianoSanchez Oct 25, 2024
7d91cc6
Merge branch 'remove_pluggable_localhost_mode' into refactor_type_def…
EmilianoSanchez Oct 25, 2024
c600e3d
2nd step: move SplitIO namespace definition from React Native SDK to …
EmilianoSanchez Oct 25, 2024
6905ae6
Polishing
EmilianoSanchez Oct 25, 2024
61eaece
Rename IClientSS to INodeClient and IAsyncClientSS to INodeAsyncClient
EmilianoSanchez Oct 25, 2024
7c3e6fa
3rc step: move SplitIO namespace definition from JS SDK to JS-Commons…
EmilianoSanchez Oct 25, 2024
901140a
rc
EmilianoSanchez Oct 25, 2024
d383fc5
Formatting
EmilianoSanchez Oct 25, 2024
61580e5
Add IReactNativeSettings to specialize the type. Fixed some defaults
EmilianoSanchez Oct 26, 2024
49d76b2
Polishing
EmilianoSanchez Oct 28, 2024
b09832f
Remove SplitIO namespace from 'src/types.ts' and reuse it from 'types…
EmilianoSanchez Oct 29, 2024
0ff9901
Fixed some types
EmilianoSanchez Oct 29, 2024
2e5df35
Polishing
EmilianoSanchez Oct 29, 2024
25a4b41
Merge branch 'refactor_type_definitions' into refactor_type_definitio…
EmilianoSanchez Oct 29, 2024
e40a824
Polishing
EmilianoSanchez Oct 29, 2024
d94771d
Merge branch 'refactor_type_definitions' into refactor_type_definitio…
EmilianoSanchez Oct 29, 2024
1e64d19
Refactor Settings interfaces
EmilianoSanchez Oct 29, 2024
4d2a5a4
Merge branch 'refactor_type_definitions' into refactor_type_definitio…
EmilianoSanchez Oct 29, 2024
912f20e
Add TSDoc linter rules
EmilianoSanchez Oct 29, 2024
1351df6
rc
EmilianoSanchez Oct 29, 2024
d13c68e
Merge branch 'breaking_changes_baseline' into refactor_type_definitions
EmilianoSanchez Oct 31, 2024
c7e8050
Merge branch 'refactor_type_definitions' into refactor_type_definitio…
EmilianoSanchez Oct 31, 2024
b352f71
Rename some TS interfaces to minimize breaking changes in JS SDK
EmilianoSanchez Oct 31, 2024
d8a3445
Polishing
EmilianoSanchez Oct 31, 2024
d052757
Move internal types outside namespace
EmilianoSanchez Oct 31, 2024
1e1d827
Revert specialization of the INodeAsyncSettings interface
EmilianoSanchez Oct 31, 2024
ecae2b2
rc
EmilianoSanchez Oct 31, 2024
549ee4f
Polishing
EmilianoSanchez Oct 31, 2024
5e115c2
Merge pull request #363 from splitio/refactor_type_definitions_intern…
EmilianoSanchez Nov 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Polishing
  • Loading branch information
EmilianoSanchez committed Oct 31, 2024
commit 549ee4fb3b80d04b65e1a504c2cbf49ffdb6fc27
26 changes: 13 additions & 13 deletions types/splitio.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ interface ISharedSettings {
urls?: SplitIO.UrlSettings;
}
/**
* Common settings properties for SDKs with synchronous API (standalone and localhost modes).
* Common settings properties for SDKs with synchronous API (standalone and localhost modes).
*/
interface ISyncSharedSettings extends ISharedSettings {
/**
Expand Down Expand Up @@ -117,9 +117,9 @@ interface ISyncSharedSettings extends ISharedSettings {
};
}
/**
* Common settings properties for SDKs with pluggable configuration.
* Common settings properties for SDKs with pluggable options.
*/
interface IPluggableSettings {
interface IPluggableSharedSettings {
/**
* Boolean value to indicate whether the logger should be enabled or disabled by default, or a log level string or a Logger object.
* Passing a logger object is required to get descriptive log messages. Otherwise most logs will print with message codes.
Expand All @@ -143,9 +143,9 @@ interface IPluggableSettings {
integrations?: SplitIO.IntegrationFactory[];
}
/**
* Common settings properties for SDKs without pluggable configuration.
* Common settings properties for SDKs without pluggable options.
*/
interface INonPluggableSettings {
interface INonPluggableSharedSettings {
/**
* Boolean value to indicate whether the logger should be enabled or disabled, or a log level string.
*
Expand All @@ -160,7 +160,7 @@ interface INonPluggableSettings {
debug?: boolean | SplitIO.LogLevel;
}
/**
* Common settings properties for server-side SDKs.
* Common settings properties for SDKs with server-side API.
*/
interface IServerSideSharedSettings {
/**
Expand Down Expand Up @@ -295,7 +295,7 @@ interface IServerSideSharedSettings {
features?: SplitIO.MockedFeaturesFilePath;
}
/**
* Common settings properties for client-side SDKs.
* Common settings properties for SDKs with client-side API.
*/
interface IClientSideSharedSettings {
/**
Expand Down Expand Up @@ -333,7 +333,7 @@ interface IClientSideSharedSettings {
userConsent?: SplitIO.ConsentStatus;
}
/**
* Common settings properties for client-side standalone SDKs.
* Common settings properties for SDKs with client-side and synchronous API (standalone and localhost modes).
*/
interface IClientSideSyncSharedSettings extends IClientSideSharedSettings, ISyncSharedSettings {
/**
Expand Down Expand Up @@ -1096,7 +1096,7 @@ declare namespace SplitIO {
*
* @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#configuration}
*/
interface IClientSideSettings extends IClientSideSyncSharedSettings, IPluggableSettings {
interface IClientSideSettings extends IClientSideSyncSharedSettings, IPluggableSharedSettings {
/**
* Defines the factory function to instantiate the storage. If not provided, the default in-memory storage is used.
*
Expand Down Expand Up @@ -1124,7 +1124,7 @@ declare namespace SplitIO {
*
* @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#sharing-state-with-a-pluggable-storage}
*/
interface IClientSideAsyncSettings extends IClientSideSharedSettings, ISharedSettings, IPluggableSettings {
interface IClientSideAsyncSettings extends IClientSideSharedSettings, ISharedSettings, IPluggableSharedSettings {
/**
* The SDK mode. When using `PluggableStorage` as storage, the possible values are "consumer" and "consumer_partial".
*
Expand Down Expand Up @@ -1216,7 +1216,7 @@ declare namespace SplitIO {
*
* @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#configuration}
*/
interface IBrowserSettings extends IClientSideSyncSharedSettings, INonPluggableSettings {
interface IBrowserSettings extends IClientSideSyncSharedSettings, INonPluggableSharedSettings {
/**
* Defines which kind of storage we can instantiate on the browser.
* Possible storage types are 'MEMORY', which is the default, and 'LOCALSTORAGE'.
Expand All @@ -1242,7 +1242,7 @@ declare namespace SplitIO {
*
* @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#configuration}
*/
interface INodeSettings extends IServerSideSharedSettings, ISyncSharedSettings, INonPluggableSettings {
interface INodeSettings extends IServerSideSharedSettings, ISyncSharedSettings, INonPluggableSharedSettings {
/**
* Defines which kind of storage we can instantiate on NodeJS for 'standalone' mode.
* The only possible storage type is 'MEMORY', which is the default.
Expand Down Expand Up @@ -1324,7 +1324,7 @@ declare namespace SplitIO {
*
* @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#configuration}
*/
interface INodeAsyncSettings extends IServerSideSharedSettings, ISharedSettings, INonPluggableSettings {
interface INodeAsyncSettings extends IServerSideSharedSettings, ISharedSettings, INonPluggableSharedSettings {
/**
* The SDK mode. When using 'REDIS' storage type, the only possible value is "consumer", which is required.
*
Expand Down