Create common typings
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 24
- Forks
- 41
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 12
Description
Many of the type definition files refer to things like Operation and State.
We should define a bunch of common typings into a module like @types/openfn-language-common.
We should be able to use this types library when compiling type definitions so that adaptor dts files look a bit like this:
import { Operations, Operation } from '@types/openfn-language-common'
export function execute(...operations: Operations): Operation;
We should also work out a way for an adaptor to describe it's state.configuration object in typescript (I guess we just export a State interface, which sets the type of configuration and proxies D to the data object).
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 by inventorying the type definition files that refer to Operation and State, then trace how adaptor declaration files are compiled. Define the scope of the common typings module and the State configuration typing, and verify that generated adaptor d.ts files can import and use those types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100