response meta object

[altintx]

I'd like to get the meta property out of response. It looks to me like your JsonApiResource interface supports it, but calls like find, findById, etc, seem to discard it. Do you have plans to support it, or, would you take a contribution to implement it?

context ed: my API exposes pagination counts by meta

[stantanasi]

Hi! I was planning on supporting this

I was thinking on doing something like this, I don't know if you find this efficient in your case.
Happy to hear your thoughts and possible amelioration

Article.find()
  .raw() // Use of .raw() to receive response body
  .then(({ result, body }) => {
    result // Article[]
    body // JsonApiBody

    body.meta // any

    body.data // JsonApiResource[]
  })

Article.findById('1')
  .raw() // Use of .raw() to receive response body
  .then(({ result, body }) => {
    result // Article
    body // JsonApiBody

    body.meta // any

    body.data // JsonApiResource
  })

[altintx]

That would meet my needs just fine. What's the rational for that being opt-in, though? Calling .raw() to emit { result, body } versus the finders always returning it?

[stantanasi]

Great!

I thought of making it opt-in because if you simply want the result, having to destructure { result } every time adds unnecessary code. For example:

const articles: Article[] = await Article.find()
const article = await Article.findById('1')

is much cleaner than:

const { result: articles } = await Article.find()
const { result: article } = await Article.findById('1')

It would feel weird to always have to write the second version for such a common case.

And in my case, I never need access to the response body, except for search, like you.

[stantanasi]

Hi! The functionality is now available in the new version 1.2.2 🎉

You can install it with:

npm install @stantanasi/jsonapi-client@latest

As I showed you, here’s how it works:

Article.find()
  .raw() // Use of .raw() to receive response body
  .then(({ result, body }) => {
    result // Article[]
    body // JsonApiBody

    body.meta // any

    body.data // JsonApiResource[]
  })

Article.findById('1')
  .raw() // Use of .raw() to receive response body
  .then(({ result, body }) => {
    result // Article
    body // JsonApiBody

    body.meta // any

    body.data // JsonApiResource
  })

Let me know if you run into anything and feel free to share any feature ideas or suggestions you’d like to see added!