Allows passed API key to be a callback function #861
Conversation
|
Hello @a11rew, PS: This message was sent automatically! |
| // Validate parameters | ||
| if (typeof hostUrl !== 'string') { | ||
| throw new TypeError( | ||
| 'Provided hostUrl value (1st parameter) is not a string, expected string' | ||
| ) | ||
| } | ||
|
|
||
| if (typeof apiKey !== 'string' && typeof apiKey !== 'function') { | ||
| throw new TypeError( | ||
| 'Provided apiKey value (2nd parameter) is not a string or a function, expected string or function' | ||
| ) | ||
| } | ||
|
|
||
| // If apiKey is function, call it to get the apiKey | ||
| if (typeof apiKey === 'function') { | ||
| const apiKeyFnValue = apiKey() | ||
| if (typeof apiKeyFnValue !== 'string') { | ||
| throw new TypeError( | ||
| 'Provided apiKey function (2nd parameter) did not return a string, expected string' | ||
| ) | ||
| } | ||
|
|
||
| // Replace apiKey with the value returned by the function | ||
| apiKey = apiKeyFnValue | ||
| } |
There was a problem hiding this comment.
It could be nice to move this to a validate.ts file to avoid to much code in the client constructor. What do you think?
There was a problem hiding this comment.
Yes that would work, moving lines 37-48 into a separate function in a different file.
I'll be leaving the call that resolves the function (lines 50-61) to a string here however so the validate function isn't returning values, just throwing errors on invalid values. What do you think, is that fine?
There was a problem hiding this comment.
What do you think about moving it to an apart function not related to validation?
function getApiKey(apiKey: string | () => string) {
// If apiKey is function, call it to get the apiKey
if (typeof apiKey === 'function') {
const apiKeyFnValue = apiKey()
if (typeof apiKeyFnValue !== 'string') {
throw new TypeError(
'Provided apiKey function (2nd parameter) did not return a string, expected string'
)
}
return apiKeyFnValue
}
return apiKey
}There was a problem hiding this comment.
Moved it out of the constructor, albeit in the same file since it throws an error specific only to the client constructor
bidoubiwa
left a comment
bidoubiwa
left a comment
There was a problem hiding this comment.
Thanks for this amazing PR 🔥
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
…meilisearch into support-api-key-callback
|
bors merge |
|
Build succeeded: |
|
This message is sent automatically Thanks again for contributing to Meilisearch ❤️ |
2 participants
Pull Request
Related issue
Fixes #765
What does this PR do?
instantMeiliSearchparametersinstantMeiliSearchparameters validationPR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!