Declarative API development

Open

#392 opened on May 27, 2021 0 comments 0 reactions 1 assignee View on GitHub

@patrick-tolosa is already working on this.

Since May 28, 2023.

Assessment

This issue has not been assessed yet.

discussion

The current API of the SDK is imperative.
@yoadsn mentioned in #382 that some users would benefit from a declarative API as well.

Points of interest

The API should be consistent across methods (Meaning we can't pick and choose which APIs have a declarative counterpart)
The API should avoid using magical strings since we aim to provide the best dev experience even to people with weak IDEs.
We might relax the constraint above if we consider the declarative API for more advanced users, but this needs to be explored before deciding.

new Image().resize(scale().width(100).height(100))

new Image().resize(scale({
  width: 100,
  height: 100
}))

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.