Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial design rationale doc #501

Merged
merged 1 commit into from
Jul 24, 2024
Merged

Initial design rationale doc #501

merged 1 commit into from
Jul 24, 2024

Conversation

ericanderson
Copy link
Member

No description provided.

@ericanderson ericanderson force-pushed the ea.design-rationale branch from f61f56b to 7baaf18 Compare July 22, 2024 14:10

### Discoverability

In v1, you might take a constructed client and say `client.ontology.objects.Car`, getting intellisense along the way. This style of discovery breaks tree shaking though so in v2, you get the discoverability from the import `import * as MyOSDK from "@my/osdk"`. Decent tree shaking tools will convert this to only importing what is needed while the IDE will present you with all the information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we maybe add that hitting ctrl-space will give you more intellisense suggestions as well? I wasn't actually aware of this myself until someone pointed it out to me, though I'm not sure if it would make sense to add that in the context of a design doc

@ericanderson ericanderson force-pushed the ea.design-rationale branch from 7baaf18 to 073c9c2 Compare July 24, 2024 20:45
@ericanderson ericanderson merged commit bc1a240 into main Jul 24, 2024
7 checks passed
@ericanderson ericanderson deleted the ea.design-rationale branch July 24, 2024 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants