chore: adding examples that are currently hard-coded in dev docs #1428
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit copies over a lot of example JS code that is currently hard-coded in the dev docs, into example files here that we can validate in CI. Also hopefully makes it easier to make sweeping changes in the future (such as our instanceof migration). A subsequent dev docs PR will consume these and get rid of the hard-coded examples.
cprice404
force-pushed
the
move-example-snippets-from-dev-docs
branch
from
f820af0 to
2cad926
Compare
malandis
reviewed
Sep 4, 2024
| @@ -0,0 +1,76 @@ | |||
| import * as fs from 'node:fs'; | |||
| import {CacheClient, CacheGetResponse, CacheSetResponse, Configurations, CredentialProvider} from '@gomomento/sdk'; | |||
|
|
|||
There was a problem hiding this comment.
Are we going to commit this file? Otherwise main just bails without error.
There was a problem hiding this comment.
? sorry i'm not following your question
There was a problem hiding this comment.
oh you're asking about the json file. hrm let me look
There was a problem hiding this comment.
this example is really for the docs site, but i can add that file.
There was a problem hiding this comment.
Woops. Yes I meant the json file. As is we can syntax check but if we run the program, without the file, the run function will return fast.
malandis
approved these changes
Sep 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit copies over a lot of example JS code that is currently
hard-coded in the dev docs, into example files here that we can
validate in CI. Also hopefully makes it easier to make sweeping
changes in the future (such as our instanceof migration).
A subsequent dev docs PR will consume these and get rid of the
hard-coded examples.