Skip to content

Commit d99e637

Browse files
smenzerpatmmccann
andauthored
drop support for userId configs with the usersync config object (#5427)
* drop support for userId configs with the `usersync` config object, per deprecation notice * changes on drop support (#1) * Update userIdTargeting.md * Update userId.md * Update userId_spec.js * Update britepoolIdSystem.md * Update sharedIdSystem.md Co-authored-by: Patrick McCann <[email protected]>
1 parent 13a347a commit d99e637

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

modules/britepoolIdSystem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ BritePool User ID Module. For assistance setting up your module please contact u
77
Individual params may be set for the BritePool User ID Submodule. At least one identifier must be set in the params.
88
```
99
pbjs.setConfig({
10-
usersync: {
10+
userSync: {
1111
userIds: [{
1212
name: 'britepoolId',
1313
storage: {

modules/sharedIdSystem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ex: $ gulp build --modules=userId,sharedIdSystem
1313
Individual params may be set for the Shared ID User ID Submodule.
1414
```
1515
pbjs.setConfig({
16-
usersync: {
16+
userSync: {
1717
userIds: [{
1818
name: 'sharedId',
1919
params: {

modules/userId/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -576,8 +576,8 @@ export function init(config) {
576576
}
577577
// listen for config userSyncs to be set
578578
config.getConfig(conf => {
579-
// Note: support for both 'userSync' and 'usersync' will be deprecated with Prebid.js 3.0
580-
const userSync = conf.userSync || conf.usersync;
579+
// Note: support for 'usersync' was dropped as part of Prebid.js 4.0
580+
const userSync = conf.userSync;
581581
if (userSync && userSync.userIds) {
582582
configRegistry = userSync.userIds;
583583
syncDelay = utils.isNumber(userSync.syncDelay) ? userSync.syncDelay : DEFAULT_SYNC_DELAY;

modules/userId/userId.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ pbjs.setConfig({
7979
Example showing `localStorage` for user id data for some submodules
8080
```
8181
pbjs.setConfig({
82-
usersync: {
82+
userSync: {
8383
userIds: [{
8484
name: "unifiedId",
8585
params: {
@@ -137,7 +137,7 @@ pbjs.setConfig({
137137
Example showing how to configure a `value` object to pass directly to bid adapters
138138
```
139139
pbjs.setConfig({
140-
usersync: {
140+
userSync: {
141141
userIds: [{
142142
name: "pubCommonId",
143143
value: {

modules/userIdTargeting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ pbjs.setConfig({
88
99
// your existing userIds config
1010
11-
usersync: {
11+
userSync: {
1212
userIds: [{...}, ...]
1313
},
1414

test/spec/modules/userId_spec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,7 @@ describe('User ID', function() {
656656
it('does not delay auction if there are no ids to fetch', function() {
657657
coreStorage.getCookie.withArgs('MOCKID').returns('123456778');
658658
config.setConfig({
659-
usersync: {
659+
userSync: {
660660
auctionDelay: 33,
661661
syncDelay: 77,
662662
userIds: [{

0 commit comments

Comments
 (0)