506 deprecate name field in API calls #722
Conversation
kriswest
requested review from
mattjamieson,
nkolba,
thorsent,
rikoe,
donbasuno,
bingenito,
hughtroeger,
ggeorgievx and
a team
✅ Deploy Preview for lambent-kulfi-cf51a7 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Co-authored-by: Hugh Troeger <htroeger@factset.com> Co-authored-by: Matt Jamieson <10372+mattjamieson@users.noreply.github.com>
|
Thanks @mattjamieson @greyseer256, suggestions applied |
|
|
||
| export function open(app: AppIdentifier | String, context?: Context): Promise<AppMetadata> { | ||
| if (isString(app)) { | ||
| return rejectIfNoGlobal(() => window.fdc3.open(app, context)); |
There was a problem hiding this comment.
Shouldn't these overloads be wrapping the string as an AppIdentifier internally? Otherwise why is there a check and if-else?
There was a problem hiding this comment.
The typeguard and check were needed as typescript will allow us to declare the different types for the function overload, but in the implementation, javascript won't (the second declaration will just overwrite the first, which typescript knows and will spit out as an error).
Hence, this looks odd in this utility file, but works correctly and looks correct in the types/docs (and provides the overload for use in other languages that actually care about the types of function arguments, which JS does not). Hence, JS implementations will still use a single function to implement both signatures and will have to do some similar type checking internally.
Makes a bit more sense when you see it in VS code and it highlights that one of the calls fdc3.open is the deprecated form:
I can't wrap the name as an AppIdentifier internally as we're missing the required appId.
Co-authored-by: Brian Ingenito <28159742+bingenito@users.noreply.github.com>
resolves #506
Removes the
TargetAppunion type (string | Appmetadata) which splits the signatures foropen,raiseIntentandraiseIntentForContextinto two versions, then deprecates the version based on on thenamefield. Also makesnameoptional, butappIdrequired and splitsAppMetadataintoAppIdentifierandAppMetadatawhich extends it - this helps to clarify what the requirements are for function calls, vs. the return types (thanks for the suggestion @thorsent).Also:
As discussed at #683