Skip to content

Document the null case for the replace rules in the debugging module #6573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robin-crazygames wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document the null case for the replace rules in the debugging module #6573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion dev-docs/modules/debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,9 @@ To illustrate, these definitions are equivalent:

### Replace rules

The replace rule can be provided as a function that takes the bid request as its only argument and returns an object with the desired response properties. The [first example above](#example) could be written as:
The replace rule can be provided as a function that takes the bid request as its only argument and returns an object with the desired response properties.
The function can also return `null` to indicate that there is no bid.
The [first example above](#example) could be written as:

```javascript
pbjs.setConfig({
Expand All @@ -137,6 +139,8 @@ Alternatively, the rule can be expressed as an object, and its `key`-`value` pai
- if `value` is a function, then `bidResponse[key]` will be set to `value(bidRequest)`;
- otherwise, `bidResponse[key]` will be set to `value`.

Using `null` as the object indicates that there was no bid.

To illustrate, the following definitions are equivalent:

```javascript
Expand Down
Loading