Node SDK intro updates - updates PLAT-1803 #15
Conversation
This file contains hidden or 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
updates to the script and instructions to make them easier to run out of the box as is.
evanfuller
approved these changes
Jul 22, 2022
nagarjun
requested changes
Jul 25, 2022
Co-authored-by: Nagarjun Palavalli <me@nagarjun.co>
Co-authored-by: Nagarjun Palavalli <me@nagarjun.co>
simplify script as per Nag's request
nagarjun
approved these changes
Jul 27, 2022
| const nfClient = new Nightfall(); | ||
| To run this sample script you must compile it as TypesScript. Save it as a `.tsc` file and run `tsc <yourfilename>.ts -lib ES2015,DOM ` | ||
|
|
||
| You can this run the resulting JavaScript file: |
Contributor
There was a problem hiding this comment.
Suggested change
| You can this run the resulting JavaScript file: | |
| You can then run the resulting JavaScript file: |
| The results from the scan are delivered by webhook; for more information about setting up a webhook server, refer to | ||
| [the docs](https://docs.nightfall.ai/docs/creating-a-webhook-server). | ||
|
|
||
| This script assumes a webhook a the location `https://my-service.com/nightfall/listener`. Update this to your webhook server address. |
Contributor
There was a problem hiding this comment.
Suggested change
| This script assumes a webhook a the location `https://my-service.com/nightfall/listener`. Update this to your webhook server address. | |
| This script assumes a webhook at the location `https://my-service.com/nightfall/listener`. Update this to your webhook server address. |
|
|
||
| To run this sample script you must compile it as TypesScript. Save it as a `.tsc` file and run `tsc <yourfilename>.ts -lib ES2015,DOM ` | ||
|
|
||
| You can this run the resulting JavaScript file: |
Contributor
There was a problem hiding this comment.
Suggested change
| You can this run the resulting JavaScript file: | |
| You can then run the resulting JavaScript file: |
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.
Perhaps these changes seem unnecessary to the non TypeScript noob, but not having to deal with these syntax issues and run time nuances would have saved me time.