Skip to content
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

Jump to bottom

add section for custom signals #7130

Merged
merged 2 commits into from
Oct 10, 2024
Merged

add section for custom signals #7130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d04a7b
add section for custom signals
alanjcharles Oct 8, 2024
007007e
Update src/connections/auto-instrumentation/web-setup.md
alanjcharles Oct 9, 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
12 changes: 12 additions & 0 deletions src/connections/auto-instrumentation/web-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,18 @@ https://my-website.com?segment_signals_debug=false

### Advanced

#### Emitting custom signals
If you need to listen for data that is unavailable to the Signals plugin by default, you can create and emit a custom signal:

```ts
import { signalsPlugin } from './analytics' // assuming you exported your plugin instance.

signalsPlugin.addSignal({
type: 'userDefined',
data: { foo: 'bar' }
})
```

#### Listening to signals
```ts
const signalsPlugin = new SignalsPlugin()
Expand Down
Loading