amplitude / amplitude/Amplitude-TypeScript

Ampli DestinationPlugin doesn't support undefined return value

Open
#308 9 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
180
Forks
68
Avg merge
3d 1h
Merged PRs (30d)
29

Description

Hello,

There's a discrepancy between the docs and the implementation of the Ampli Plugin.

I'm trying to write a plugin to forward data to other services and in some cases not to Amplitude, just like [this middleware from the docs](https://www.docs.developers.amplitude.com/data/ampli/middleware/#forward-data-to-other-services-but-not-amplitude).

## Expected Behavior
According to the [docs](https://www.docs.developers.amplitude.com/data/ampli/plugin/#forward-data-to-other-services-but-not-amplitude):
> if used as a destination type plugin, the expected return value is undefined

## Current Behavior

This is not the case in the code: https://github.com/amplitude/Amplitude-TypeScript/blob/main/packages/analytics-types/src/plugin.ts#L25

## Possible Solution

Update docs / change type to allow DestinationPlugins to return undefined

## Environment
- JS SDK Version: 1.6.7
- Installation Method: yarn
- Browser and Version: Brave v1.46.153

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.