Exposing raw data from parsed entities

[lbstr]

This is a proof of concept of @KalebMills 's comment here. Let me know what you think!

Summary

We return parsed entities, but they include a method, raw(), which you can call to get the raw data.

Pros

• We always provide parsed data, so users with the most common use case don't need to do anything special
• We provide a way to get the raw data if you are a weirdo and want it
• raw() is a method, not a field, so we aren't cluttering the data if you want to shove it in a data store
• If you want to perform additional mapping/parsing, you can do so in user code and you'll have access to both the raw and parsed data

Cons

• When we define raw() in our parser methods, we create a closure. We ruin garbage collection, so we technically have a small memory leak here.
  • I think if we deep clone the raw data and return that, we can get around this problem.
  • I'm not a fan of optimizing stuff like this until we have a measurable problem, so I'm not inclined to worry about it yet. Let me know what you think.

Example

const client = new Client();

const account = await client.getAccount();
const rawAccount = account.raw();

console.log(typeof account.buying_power); // number
console.log(typeof rawAccount.buying_power); // string

[lbstr]

If we want to move forward this idea, we should document this in the README. I just want to get some feedback first before we do that.

[KalebMills]

This looks good to me. I think this makes this package a little more robust. The small memory leak shouldn't be an issue, but like you said, after some usage it'll be easier to measure if it has any impact.

[117]

I like this way of doing it.

[lbstr]

OK I added some info in the README. Let me know if you would like to see any changes here.

[117]

At what point do we feel a merge into master is ready? I'm going to test the current dev changes tomorrow on paper. Is there much more we want to add before a 2.0 release?

[lbstr]

@117 My hunch is next week we should be good. There's a little more to do on the number parsing and I have a few other things. I'll get all of my notes into Issues so we can discuss which ones we want for 2.0. I think they are all quick things.