8bitdesigner / tp-api Goto Github PK

It might be beneficial to make a breaking change to convert then's interface over to just emit the found entities, and have a separate catch callback, so that requests adhere to Promise's interface. This would allow easy interop with async/await

Awesome API, I had to make an alteration though to use http. I may not be doing it right but I at least got it working after playing with your code. Maybe you wanna add the option to index.js?

var protocol = opts.insecure ? 'http://' : 'https://'
var url = protocol+.....

@8bitDesigner , could you release current master as 1.0.6 so that npm install tp-api installs 1.0.6?

Update: or maybe I can release it?

First, thank you for tp-api. The code still works, I'd just like to suggest adding one note to readme.

Using a very similar example to the one from readme:

tp('Tasks')
  .take(1)
  .where("EntityState.Name eq 'Open'")
  .pluck("CustomFields")
  .sortBy('NumericPriority')
  .then(function(err, tasks) {
    console.log('my tasks', tasks)
  }
)

The returned tasks here is a JavaScript object which can return:

my tasks [ { ResourceType: 'Task',
    Id: 3631,
    Project: { ResourceType: 'Project', Id: 4026, Process: [Object] },
    CustomFields: [ [Object], [Object], [Object], [Object], [Object] ] } ]

In order to convert it into JSON string, the following is enough:

tp('Tasks')
  .take(1)
  .where("EntityState.Name eq 'Open'")
  .pluck("CustomFields")
  .sortBy('NumericPriority')
  .then(function(err, tasks) {
    console.log('my tasks', JSON.stringify(tasks))  // changed here
  }
)

and now it returns:

my tasks [{"ResourceType":"Task","Id":3631,"Project":{"ResourceType":"Project","Id":4026,"Process":{"Id":5,"Name":"AIScrum"}},"CustomFields":[{"Name":"Component","Type":"DropDown","Value":null},{"Name":"trac","Type":"Number","Value":null},{"Name":"Job","Type":"DropDown","Value":null},{"Name":"Resolution","Type":"DropDown","Value":null},{"Name":"Domain","Type":"DropDown","Value":null}]}]

It took me some time to find out about it, so I'd like to spare this time for others.