Type the sync reply from lightning in lexicon
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 17
Description
Properly type a sync reply in lexicon. something like below. but first verify the structure
/** The `{data, meta}` envelope Lightning puts around every completed sync reply. */
interface SyncReply {
data: unknown;
meta: {
work_order_id: string;
run_id: string;
state: string;
error_type: string | null;
};
}
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the lexicon code that handles Lightning sync replies and verify the actual completed-reply envelope before defining the type. Use the verified structure for the sync reply, then confirm the lexicon's existing type checks or tests pass and that the reply is typed consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100