Skip to content

Commit

Permalink
Update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
EmilianoSanchez committed Oct 28, 2024
1 parent 1fedc69 commit eb06c6a
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 7 deletions.
2 changes: 1 addition & 1 deletion src/full/splitFactory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const platform = { getFetch, getEventSource, EventEmitter, now };

/**
* SplitFactory with pluggable modules for Browser.
* Includes fetch polyfill out-of-the-box.
* It includes a `fetch` polyfill out-of-the-box.
*
* @param config configuration object used to instantiate the SDK
* @param __updateModules optional function that lets redefine internal SDK modules. Use with
Expand Down
3 changes: 1 addition & 2 deletions src/splitFactory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ import { IBrowserSettings } from '../types/splitio';
const platform = { getFetch, getEventSource, EventEmitter, now };

/**
* Slim SplitFactory with pluggable modules for Browser.
* Doesn't include fetch ponyfill out-of-the-box.
* SplitFactory with pluggable modules for Browser.
*
* @param config configuration object used to instantiate the SDK
* @param __updateModules optional function that lets redefine internal SDK modules. Use with
Expand Down
2 changes: 1 addition & 1 deletion types/full/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ declare module JsSdk {
/**
* Full version of the Split.io SDK factory function.
*
* Unlike the slim version, it doesn't require a 'fetch' polyfill to support old browsers @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#language-support}.
* It includes a `fetch` polyfill out-of-the-box. @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#language-support}.
*
* The settings parameter should be an object that complies with the SplitIO.IBrowserSettings.
* For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#configuration}
Expand Down
4 changes: 1 addition & 3 deletions types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ export = JsSdk;

declare module JsSdk {
/**
* Slim version of the Split.io SDK factory function.
*
* Recommended to use for bundle size reduction in production, since it doesn't include a 'fetch' polyfill out-of-the-box
* Split.io SDK factory function.
*
* The settings parameter should be an object that complies with the SplitIO.IBrowserSettings.
* For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#configuration}
Expand Down

0 comments on commit eb06c6a

Please sign in to comment.