search

pofallon / node-bluesky

A lightweight, simplified node.js library for accessing Windows Azure
15 stars 4 forks source link

Documentation #21

Open craftery opened 12 years ago

craftery commented 12 years ago

Is the api fully documented anywhere?

pofallon commented 12 years ago

It's all documented on the wiki associated with the Github project. If you don't find what you're looking for there, let me know. Thanks!

Sent from my iPad

On Aug 23, 2012, at 12:30 PM, craftery notifications@github.com wrote:

Is the api fully documented anywhere?

— Reply to this email directly or view it on GitHubhttps://github.com/pofallon/node-bluesky/issues/21.

craftery commented 12 years ago

Thanks for getting back Paul. I was trying to locate a full list of 'magic' event strings - like the 'data' event in container.list().on('data'... and the 'end' event in storage.listTables().on('end'... These two are mentioned in the api wiki on their respective containers but is there a full list of events that the bluesky api supports? Thanks

On 23 August 2012 17:33, Paul O'Fallon notifications@github.com wrote:

It's all documented on the wiki associated with the Github project. If you don't find what you're looking for there, let me know. Thanks!

Sent from my iPad

On Aug 23, 2012, at 12:30 PM, craftery notifications@github.com wrote:

Is the api fully documented anywhere?

— Reply to this email directly or view it on GitHubhttps://github.com/pofallon/node-bluesky/issues/21.

— Reply to this email directly or view it on GitHubhttps://github.com/pofallon/node-bluesky/issues/21#issuecomment-7975523.

pofallon commented 12 years ago

You're welcome! The methods which return an event emitter in the absence of a callback will emit "data" and "end" events. The only other magic event string is the "message" event emitted by a queue when polling for new messages.

I'll make that more clear / consistent in the wiki.

On Aug 23, 2012, at 12:51 PM, craftery notifications@github.com wrote:

Thanks for getting back Paul. I was trying to locate a full list of 'magic' event strings - like the 'data' event in container.list().on('data'... and the 'end' event in storage.listTables().on('end'... These two are mentioned in the api wiki on their respective containers but is there a full list of events that the bluesky api supports? Thanks

On 23 August 2012 17:33, Paul O'Fallon notifications@github.com wrote:

It's all documented on the wiki associated with the Github project. If you don't find what you're looking for there, let me know. Thanks!

Sent from my iPad

On Aug 23, 2012, at 12:30 PM, craftery notifications@github.com wrote:

Is the api fully documented anywhere?

— Reply to this email directly or view it on GitHubhttps://github.com/pofallon/node-bluesky/issues/21.

— Reply to this email directly or view it on GitHub< https://github.com/pofallon/node-bluesky/issues/21#issuecomment-7975523>.

— Reply to this email directly or view it on GitHubhttps://github.com/pofallon/node-bluesky/issues/21#issuecomment-7976129.

pofallon commented 12 years ago

One more thing -- 'error' events can also be emitted in addition to 'data' and 'end events.