docs: update readme with typescript setup #1
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
|
mainmatter#2514 (comment) |
steveszc
reviewed
Mar 28, 2023
|
@steveszc I have made the requested changes. Please merge if it's OK now. |
steveszc
requested changes
Apr 6, 2023
| import type Session from 'ember-simple-auth/services/session'; | ||
|
|
||
| interface SessionData = { | ||
| access_token: String, |
There was a problem hiding this comment.
Sorry I just noticed this...
string needs to be lowercase here and on the next line.
| import { inject as service } from '@ember/service'; | ||
| import type Session from 'ember-simple-auth/services/session'; | ||
|
|
||
| interface SessionData = { |
There was a problem hiding this comment.
Can we include authenticator: string; on this interface?
| @@ -107,6 +107,31 @@ Installing the library is as easy as: | |||
| ember install ember-simple-auth | |||
| ``` | |||
|
|
|||
| ### TypeScript setup | |||
| 1. Include `ember-simple-auth` typescript defs in the `tsconfig.json` under `paths` like this: | |||
There was a problem hiding this comment.
Can we make a note that this may not be required depending on your TS configuration. I am not sure that this is strictly required in every situation. If you are positive it is needed then please disregard.
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 PR adds TypeScript setup info to the README.md