{"action":"created","issue":{"url":"https://api.github.com/repos/peterbraden/node-opencv/issues/511","repository_url":"https://api.github.com/repos/peterbraden/node-opencv","labels_url":"https://api.github.com/repos/peterbraden/node-opencv/issues/511/labels{/name}","comments_url":"https://api.github.com/repos/peterbraden/node-opencv/issues/511/comments","events_url":"https://api.github.com/repos/peterbraden/node-opencv/issues/511/events","html_url":"https://github.com/peterbraden/node-opencv/issues/511","id":234313500,"number":511,"title":"TypeScript definition file proposal","user":{"login":"troywweber7","id":4765979,"avatar_url":"https://avatars3.githubusercontent.com/u/4765979?v=3","gravatar_id":"","url":"https://api.github.com/users/troywweber7","html_url":"https://github.com/troywweber7","followers_url":"https://api.github.com/users/troywweber7/followers","following_url":"https://api.github.com/users/troywweber7/following{/other_user}","gists_url":"https://api.github.com/users/troywweber7/gists{/gist_id}","starred_url":"https://api.github.com/users/troywweber7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/troywweber7/subscriptions","organizations_url":"https://api.github.com/users/troywweber7/orgs","repos_url":"https://api.github.com/users/troywweber7/repos","events_url":"https://api.github.com/users/troywweber7/events{/privacy}","received_events_url":"https://api.github.com/users/troywweber7/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-06-07T19:14:55Z","updated_at":"2017-06-08T07:48:40Z","closed_at":null,"body":"I'm currently trying to work with this project and develop a typescript definition file as I go (at a minimum for the features I'm using). As I amass definitions that match your bindings, I may eventually want to publish them for other people to use/improve.\r\n\r\nThere are two ways to do this: (1) bundle it with the repository in question or (2) publish it to DefinitelyTyped. Method (1) is preferred by all developers (including Microsoft, the creators of typescript), but of course method (2) is just as valid. If I went with method (1) the only addition to your project would be a single file by the name of `index.d.ts`. A typescript definition file like this streamlines the usage of pure javascript modules within a typescript project and makes it easier over time to investigate module functionality. In a way it will extend the documentation which would be useful for your project because it lacks so much documentation.\r\n\r\nIf method (1) is something you'd be okay with, then I'd be happy to discuss it here or perform a pull request in the future.\r\n\r\nThanks for your input!"},"comment":{"url":"https://api.github.com/repos/peterbraden/node-opencv/issues/comments/307026810","html_url":"https://github.com/peterbraden/node-opencv/issues/511#issuecomment-307026810","issue_url":"https://api.github.com/repos/peterbraden/node-opencv/issues/511","id":307026810,"user":{"login":"peterbraden","id":52586,"avatar_url":"https://avatars1.githubusercontent.com/u/52586?v=3","gravatar_id":"","url":"https://api.github.com/users/peterbraden","html_url":"https://github.com/peterbraden","followers_url":"https://api.github.com/users/peterbraden/followers","following_url":"https://api.github.com/users/peterbraden/following{/other_user}","gists_url":"https://api.github.com/users/peterbraden/gists{/gist_id}","starred_url":"https://api.github.com/users/peterbraden/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/peterbraden/subscriptions","organizations_url":"https://api.github.com/users/peterbraden/orgs","repos_url":"https://api.github.com/users/peterbraden/repos","events_url":"https://api.github.com/users/peterbraden/events{/privacy}","received_events_url":"https://api.github.com/users/peterbraden/received_events","type":"User","site_admin":false},"created_at":"2017-06-08T07:48:40Z","updated_at":"2017-06-08T07:48:40Z","body":"My main worry would be that the typescript definition would get out of date. I'm not willing to _require_ contributors to keep it up to date as not all of them use typescript.\r\n\r\nI appreciate the work, and I'd love to be kept up to date with progress, but my instinct is that method (2) would be a better fit."}}
{"actor":{"display_login":"peterbraden"}}