[6.0.0] feat(Singleton): implement the API wrapper as a singleton #88
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
marcelscr
requested review from
FranciscoGileno,
julianalucena and
ottony
as code owners
FranciscoGileno
approved these changes
Jul 31, 2024
leonardoAnjos16
approved these changes
Aug 1, 2024
README.md
Outdated
|
|
||
| Instead of creating an instance of the `IncogniaApi` class using your API credentials, just initialize the `IncogniaApi` with your credentials using the `init()` method. Initializing the `IncogniaApi` is a required step and must be done before calling any of the other `IncogniaApi` methods. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```js |
| if (!installationId) { | ||
| throw new IncogniaError('No installationId provided') | ||
| } | ||
| if (!IncogniaApi.instance) throw new IncogniaError(errorMessages.INIT) |
There was a problem hiding this comment.
I was thinking: it would be nice to have a decorator function that performs this check. I think we could avoid a lot of repetition. But I realize there are not a lot of functions and the check is simple. Do you think it would be worth it?
There was a problem hiding this comment.
Pensei em não fazer só pelo código de check ser simples mesmo. Acho que seria parecido em termos de complexidade.
marcelscr
changed the title
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.
Esse PR modifica a classe
IncogniaApipara usar um singleton e ter métodos estáticos.Por limitar o acesso à instância, tive que refatorar a classe para extrair as lógicas de gestão de token e de request para arquivos próprios, permitindo que essa lógica fosse testada direitinho.
O novo uso vai ficar assim:
Essa mudança é quebrante, e o release deve ser feito em um major release na
v6.0.0.