groupme-js / groupme-js/node-groupme

Add Resolvable types

Open
#51 0 comments 0 reactions 0 assignees View on GitHub
enhancement question
Dominant language
TypeScript
Stars
27
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Several methods could benefit from abstract resolvable types for parameters.

For example: `Groups#add(user)` could take a user ID string, a `User` object, or even a `Member` object.

Some possible resolvable types:
```ts
type UserResolvable = string | User;
type MemberResolvable = string | Member; // could User work here too?
type GroupResolvable = string | Group; // would it be a good idea to include Member here?
```

The corresponding class would have (static?) methods for resolving these.
```ts
Group.resolve(GroupResolvable): Group // do these need to be async...?
Member.resolve(MemberResolvable): Member
User.resolve(UserResolvable): User
```

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.