Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Add minimal docs to the NPM library #235

Open
mxdvl opened this issue Feb 8, 2024 · 0 comments
Open

Add minimal docs to the NPM library #235

mxdvl opened this issue Feb 8, 2024 · 0 comments
Labels
enhancement

Comments

@mxdvl
Copy link

mxdvl commented Feb 8, 2024 •
edited
Loading

It could help adoption by JS consumers.

So this is how one use the models from content-api-models https://github.com/guardian/dotcom-rendering/blob/8c46c6b669b600b439c5585f99678fee75a7a451/apps-rendering/src/capi.ts#L6

Basically you just import the model you would like

The elements you can find are in the thrift file
https://github.com/guardian/content-api-models/blob/main/models/src/main/thrift/content/v1.thrift#L1897
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mxdvl