Extend CallBuilder to support join.
#436
Conversation
| @@ -258,9 +269,11 @@ export class CallBuilder< | |||
| // If the key with the link name already exists, create a copy | |||
| if (typeof json[key] !== "undefined") { | |||
| json[`${key}_attr`] = json[key]; | |||
| const record = this._parseRecord(json[key]); | |||
| json[key] = async () => record; | |||
There was a problem hiding this comment.
This keeps the same API regardless if the record is coming from the payload or from links. That is, if you want to get the transaction, you'll call record.transaction() which will return a promise.
| * @param {"transactions"} join Records to be included in the response. | ||
| * @returns {object} current CallBuilder instance. | ||
| */ | ||
| public join(include: "transactions"): this { |
There was a problem hiding this comment.
This is a string literal, it will force this value to be transactions -- Once join supports more types and we know the query param shape, we'll be able to add more validations into this.
There was a problem hiding this comment.
Does this error at runtime? I think it should throw a visible error.
There was a problem hiding this comment.
@morleyzhi yeah it does, if there is an error then it will bubble up from the server and handled by our error handling. Also if you are in TS --then you will be allowed to pass only "transactions" which is the only valid value for now.
abuiles
force-pushed
the
add-join-support
branch
6 times, most recently
from
654147d
to
12417dd
Compare
Use data from join Whitelist resources which can be loaded via join. Use string literal for join param. Don't use async/await in test 😭
abuiles
force-pushed
the
add-join-support
branch
from
12417dd
to
3822b0f
Compare
| * @param {"transactions"} join Records to be included in the response. | ||
| * @returns {object} current CallBuilder instance. | ||
| */ | ||
| public join(include: "transactions"): this { |
There was a problem hiding this comment.
Does this error at runtime? I think it should throw a visible error.
This PR adds support for the
joinquery parameters added on Horizon v0.19.0, which allows side-loading of related resources.For now
joinonly supportstransactions.Fixes #433