haxefoundation / hxnodelibs Goto Github PK

View Code? Open in Web Editor NEW

14.0 12.0 8.0 152 KB

License: MIT License

Haxe 100.00%

hxnodelibs's Introduction

Haxe NodeLibs

Overview

Extern type definitions for the most common Node.JS Libraries like:

mongodb
express
multiparty
nodewebkit

Haxe-generated API documentation is available at []

Original node.js documentation can be found at http://nodejs.org/api/index.html.

Features

Example

Status

This library is currently WIP.

Requires Haxe 3.2RC1 or later (builds available at http://builds.haxe.org/)

hxnodelibs's People

Contributors

Stargazers

Watchers

Forkers

dionjwa delahee andyli markknol crazyflasher isabella232

hxnodelibs's Issues

Please consider support Thread,Sqlite,WebSocket :)

Please consider support Thread,Sqlite,WebSocket libs :)

WebSocketServer usage

Someone on #haxe asked how to use this class: https://github.com/HaxeFoundation/hxnodelibs/blob/master/js/node/ws/WebSocketServer.hx

The problem is that the WebSocketServerOption class has no constructor, so there's nothing you can pass to the constructor of WebSocketServer. That type should either be a typedef structure or get a constructor, depending on what makes more sense.

@eduardo-costa

`haxe build.hxml` fails, requires importing hxnodejs.

On current master, when I try:

haxe build.hxml

it fails with:

js/npm/tarstream/TarStream.hx:10: characters 7-21 : Type not found : js.node.Buffer

That is an npm extern that I added. It fails because the haxelib hxnodejs is not imported in the build.hxml. I'm surprised that importing e.g. Buffer hasn't been required up until now. Am I misunderstanding something?

js.npm.ws.WebSocket has no field binaryType?

s.npm.ws.WebSocket has no field binaryType?

https://github.com/websockets/ws/blob/4f293a8726092c75539287dd07358afaf151a2e5/lib/websocket.js#L=102

Request to be a contributor

Hi. I'd like to become a contributor so I can help with PR reviews, since I will be regularly submitting PRs myself.

package naming and file placing

Now when hxnodejs is finally released, we can discuss a bit about this extern collection.

I don't like how it's currently done here using js.node as a prefix package since it may introduce conflicts with core node modules added at some time, also I don't like the fact that one can't easily say which is node API and which is a npm module.

@clemos uses js.npm prefix which I think is better, but I don't quite like that different externs (of different quaility and by different authors) are placed in one root - it gets messy when there are lots of them, IMO.

I wonder if we can/should use separate source paths for different npm externs and somehow still be able to just do -lib hxnodelibs and then simply import js.npm.Whatever. Maybe with macro that adds class paths and is executed in extraParams.hxml?

That way extern authors can also provide README's, tests, examples, etc.

Thoughts? @clemos @ncannasse @andyli @dionjwa @fponticelli @eduardo-costa @tong @back2dos (please cc anyone i forgot)