Skip to content

Document .parse() and .generate() #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrewcharnley opened this issue Apr 6, 2016 · 3 comments
Open

Document .parse() and .generate() #103

andrewcharnley opened this issue Apr 6, 2016 · 3 comments

Comments

@andrewcharnley
Copy link

On the readme, since these are going to be used by anyone not running the node script directly.

@BYK
Copy link
Collaborator

BYK commented Apr 7, 2016

I wouldn't rely on the API too much since this project is still not 1.0

@andrewcharnley
Copy link
Author

Not want I want to hear, it's going to be integrated into the Igaro App project and I've found it to work reliable so far.

I'll clean & document if you don't have the time, but let me know before hand else I'll fork.

Cheers, A.

@BYK
Copy link
Collaborator

BYK commented Apr 8, 2016

The project is currently trying to convert different file formats into JS and then parses that which is not really ideal. The plan was to use dedicated parsers for each file type (and may be even plugins) and encapsulate the extraction part to those specific things instead of trying to cast everything into JS (sometimes fake JS).

I think you can rely on these versions but with the change I mentioned above, the programmatic API may change in an incompatible way.

If you have the time I'd appreciate a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants