feat(kitsu): Configurable modern query serializer #828
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.
Resolves discussion from #781
This PR aims to introduce the following:
id_in[]
andid_in][
and ensure they appear intuitively in the query (filter[id_in][]
)Previous behaviour would generate keys like
filter[id_in[]]
, requiring unintuitive keysid_in][
in order to achieve the expected behaviour.query
method configurable, by allowing an option to be passed to theKitsu
class constructor2.1 Allow the user to switch between
traditional
(current behaviour) andmodern
mode. Modern mode allows to automatic generation of array style keys when passing an array toparams
, instead of having to explicitly declare them:traditional
api.get('anime', {filter: {id_in[]: [1,2]}}) -> filter[id_in][]=1&filter[id_in][]=2
modern
api.get('anime', {filter: {id_in: [1,2]}}) -> filter[id_in][]=1&filter[id_in][]=2
2.2 Allow arbitrary serialization functions to be passed, for customized handling (
(obj: any) => string
)const api = new Kitsu({ query: (obj) => /* handle serialization */ })