apollographql / apollographql/graphql-subscriptions

Consider renaming "asyncIterator" to "register"

Open
#155 1 comment 1 reaction 0 assignees View on GitHub
question
Dominant language
TypeScript
Stars
1.6k
Forks
129
PR merge metrics
No merged PRs in 30d

Description

From a first glance of the signature

```
asyncIterator(triggers: string | string[]): AsyncIterator;
```

Seems it's more like a `register` method to add one or more event names to listen to, does it make sense to consider renaming it to just that?

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the public TypeScript signature shown in the issue and the surrounding subscription API to determine whether asyncIterator is intended as a registration method. Done means reaching a naming decision and, if approved, updating the exposed API consistently with its callers and tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
api, backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.