{"action":"created","comment":{"url":"https://api.github.com/repos/sinonjs/lolex/pulls/comments/229592327","pull_request_review_id":170126028,"id":229592327,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIyOTU5MjMyNw==","diff_hunk":"@@ -0,0 +1,329 @@\n+# lolex\n+\n+JavaScript implementation of timing related web APIs.\n+\n+**Implements:**\n+\n+* [`setTimeout`](#settimeoutcallback-timeout-args)\n+* [`clearTimeout`](#cleartimeoutid)\n+* [`setImmediate`](#setimmediatecallback-args)\n+* [`clearImmediate`](#clearimmediateid)\n+* [`setInterval`](#setintervalcallback-timeout-args)\n+* [`clearInterval`](#clearintervalid)\n+* [`requestAnimationFrame`](#requestanimationframecallback)\n+* [`cancelAnimationFrame`](#cancelanimationframeid)\n+* [`Date`](#date)\n+* [`nextTick`](#nexttickcallback-args)\n+* [`queueMicrotask`](#queuemicrotaskcallback)\n+* [`performance.now`](#performancenow)\n+\n+along with a clock instance that controls the flow of time.\n+**lolex** also provides a [`Date`](#date) implementation that gets its time from the clock.\n+\n+**lolex** can be used to simulate passing time in automated tests and other\n+situations where you want the scheduling semantics, but don't want to actually\n+wait (however, from version 2.0 **lolex** supports those of you who would like to wait too).\n+\n+**lolex** is a part of [Sinon.JS](https://github.com/sinonjs/sinon.js).\n+\n+## Installation\n+\n+```shell\n+npm install lolex --save-dev\n+```\n+\n+You are always free to [build it yourself](https://github.com/sinonjs/lolex/blob/master/package.json#L22), of course.\n+\n+## Usage\n+\n+**lolex** can be used in both Node.js and browser environments.\n+\n+In addition in browser environment **lolex** provides a [`performance`](#performancenow) implementation that gets its time from the clock.\n+In Node.js environments **lolex** provides a [`nextTick`](#nexttick) implementation that is synchronized with the clock - and a [`process.hrtime`](#hrtimeprevtime) shim that works with the clock.\n+\n+If you want to use **lolex** in a browser you can use\n+[the pre-built version](https://github.com/sinonjs/lolex/blob/master/lolex.js)\n+available in the repo and the npm package.\n+\n+Using npm you only need to reference **lolex** in your `<script>` tags.\n+\n+```html\n+<script type=\"text/javascript\" src=\"https://unpkg.com/lolex@1.4.0/src/lolex.js\">","path":"docs/index.md","position":null,"original_position":51,"commit_id":"bcc0660439fc150a04f60289195761932dbb14ce","original_commit_id":"9d684cdf5ea422316d91bb685b9679dfd159c186","user":{"login":"mgred","id":2325260,"node_id":"MDQ6VXNlcjIzMjUyNjA=","avatar_url":"https://avatars3.githubusercontent.com/u/2325260?v=4","gravatar_id":"","url":"https://api.github.com/users/mgred","html_url":"https://github.com/mgred","followers_url":"https://api.github.com/users/mgred/followers","following_url":"https://api.github.com/users/mgred/following{/other_user}","gists_url":"https://api.github.com/users/mgred/gists{/gist_id}","starred_url":"https://api.github.com/users/mgred/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mgred/subscriptions","organizations_url":"https://api.github.com/users/mgred/orgs","repos_url":"https://api.github.com/users/mgred/repos","events_url":"https://api.github.com/users/mgred/events{/privacy}","received_events_url":"https://api.github.com/users/mgred/received_events","type":"User","site_admin":false},"body":"Also changed the text to mention `unpkg` instead of `npm`\r\n> Using `unpkg` you only need to reference **lolex** in your `<script>` tags.","created_at":"2018-10-31T07:57:24Z","updated_at":"2018-10-31T07:57:24Z","html_url":"https://github.com/sinonjs/lolex/pull/221#discussion_r229592327","pull_request_url":"https://api.github.com/repos/sinonjs/lolex/pulls/221","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/sinonjs/lolex/pulls/comments/229592327"},"html":{"href":"https://github.com/sinonjs/lolex/pull/221#discussion_r229592327"},"pull_request":{"href":"https://api.github.com/repos/sinonjs/lolex/pulls/221"}},"in_reply_to_id":229479972},"pull_request":{"url":"https://api.github.com/repos/sinonjs/lolex/pulls/221","id":224303017,"node_id":"MDExOlB1bGxSZXF1ZXN0MjI0MzAzMDE3","html_url":"https://github.com/sinonjs/lolex/pull/221","diff_url":"https://github.com/sinonjs/lolex/pull/221.diff","patch_url":"https://github.com/sinonjs/lolex/pull/221.patch","issue_url":"https://api.github.com/repos/sinonjs/lolex/issues/221","number":221,"state":"open","locked":false,"title":"Documentation refactoring","user":{"login":"mgred","id":2325260,"node_id":"MDQ6VXNlcjIzMjUyNjA=","avatar_url":"https://avatars3.githubusercontent.com/u/2325260?v=4","gravatar_id":"","url":"https://api.github.com/users/mgred","html_url":"https://github.com/mgred","followers_url":"https://api.github.com/users/mgred/followers","following_url":"https://api.github.com/users/mgred/following{/other_user}","gists_url":"https://api.github.com/users/mgred/gists{/gist_id}","starred_url":"https://api.github.com/users/mgred/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mgred/subscriptions","organizations_url":"https://api.github.com/users/mgred/orgs","repos_url":"https://api.github.com/users/mgred/repos","events_url":"https://api.github.com/users/mgred/events{/privacy}","received_events_url":"https://api.github.com/users/mgred/received_events","type":"User","site_admin":false},"body":"#### Purpose\r\n\r\nSee #219 \r\n\r\n#### Background (Problem in detail)\r\n\r\nAdds:\r\n* `CONTRIBUTING.md`\r\n* `docs/index.md` as the main documentation file\r\n* mkdocs.yml config file\r\n\r\n#### Tasks\r\n\r\n* [ ] Enable 3rd level heading to be linked in TOC\r\n\r\n#### Preview\r\n\r\nhttps://mgred.github.io/lolex/\r\n\r\n#### Solution\r\n\r\n* [Install](https://www.mkdocs.org/#installation) MkDocs\r\n* Checkout this branch\r\n* run `mkdocs serve -f mkdocs.yml`\r\n* check out the docs at `localhost:8000` (default)","created_at":"2018-10-19T14:18:41Z","updated_at":"2018-10-31T07:57:24Z","closed_at":null,"merged_at":null,"merge_commit_sha":"a192e119149f22a8bfcd471df3f8cc52e9b921b4","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/sinonjs/lolex/pulls/221/commits","review_comments_url":"https://api.github.com/repos/sinonjs/lolex/pulls/221/comments","review_comment_url":"https://api.github.com/repos/sinonjs/lolex/pulls/comments{/number}","comments_url":"https://api.github.com/repos/sinonjs/lolex/issues/221/comments","statuses_url":"https://api.github.com/repos/sinonjs/lolex/statuses/bcc0660439fc150a04f60289195761932dbb14ce","head":{"label":"mgred:lolex/219","ref":"lolex/219","sha":"bcc0660439fc150a04f60289195761932dbb14ce","user":{"login":"mgred","id":2325260,"node_id":"MDQ6VXNlcjIzMjUyNjA=","avatar_url":"https://avatars3.githubusercontent.com/u/2325260?v=4","gravatar_id":"","url":"https://api.github.com/users/mgred","html_url":"https://github.com/mgred","followers_url":"https://api.github.com/users/mgred/followers","following_url":"https://api.github.com/users/mgred/following{/other_user}","gists_url":"https://api.github.com/users/mgred/gists{/gist_id}","starred_url":"https://api.github.com/users/mgred/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mgred/subscriptions","organizations_url":"https://api.github.com/users/mgred/orgs","repos_url":"https://api.github.com/users/mgred/repos","events_url":"https://api.github.com/users/mgred/events{/privacy}","received_events_url":"https://api.github.com/users/mgred/received_events","type":"User","site_admin":false},"repo":{"id":147367653,"node_id":"MDEwOlJlcG9zaXRvcnkxNDczNjc2NTM=","name":"lolex","full_name":"mgred/lolex","private":false,"owner":{"login":"mgred","id":2325260,"node_id":"MDQ6VXNlcjIzMjUyNjA=","avatar_url":"https://avatars3.githubusercontent.com/u/2325260?v=4","gravatar_id":"","url":"https://api.github.com/users/mgred","html_url":"https://github.com/mgred","followers_url":"https://api.github.com/users/mgred/followers","following_url":"https://api.github.com/users/mgred/following{/other_user}","gists_url":"https://api.github.com/users/mgred/gists{/gist_id}","starred_url":"https://api.github.com/users/mgred/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mgred/subscriptions","organizations_url":"https://api.github.com/users/mgred/orgs","repos_url":"https://api.github.com/users/mgred/repos","events_url":"https://api.github.com/users/mgred/events{/privacy}","received_events_url":"https://api.github.com/users/mgred/received_events","type":"User","site_admin":false},"html_url":"https://github.com/mgred/lolex","description":"Fake setTimeout and friends (collectively known as \"timers\"). Useful in your JavaScript tests. Extracted from Sinon.JS","fork":true,"url":"https://api.github.com/repos/mgred/lolex","forks_url":"https://api.github.com/repos/mgred/lolex/forks","keys_url":"https://api.github.com/repos/mgred/lolex/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mgred/lolex/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mgred/lolex/teams","hooks_url":"https://api.github.com/repos/mgred/lolex/hooks","issue_events_url":"https://api.github.com/repos/mgred/lolex/issues/events{/number}","events_url":"https://api.github.com/repos/mgred/lolex/events","assignees_url":"https://api.github.com/repos/mgred/lolex/assignees{/user}","branches_url":"https://api.github.com/repos/mgred/lolex/branches{/branch}","tags_url":"https://api.github.com/repos/mgred/lolex/tags","blobs_url":"https://api.github.com/repos/mgred/lolex/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mgred/lolex/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mgred/lolex/git/refs{/sha}","trees_url":"https://api.github.com/repos/mgred/lolex/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mgred/lolex/statuses/{sha}","languages_url":"https://api.github.com/repos/mgred/lolex/languages","stargazers_url":"https://api.github.com/repos/mgred/lolex/stargazers","contributors_url":"https://api.github.com/repos/mgred/lolex/contributors","subscribers_url":"https://api.github.com/repos/mgred/lolex/subscribers","subscription_url":"https://api.github.com/repos/mgred/lolex/subscription","commits_url":"https://api.github.com/repos/mgred/lolex/commits{/sha}","git_commits_url":"https://api.github.com/repos/mgred/lolex/git/commits{/sha}","comments_url":"https://api.github.com/repos/mgred/lolex/comments{/number}","issue_comment_url":"https://api.github.com/repos/mgred/lolex/issues/comments{/number}","contents_url":"https://api.github.com/repos/mgred/lolex/contents/{+path}","compare_url":"https://api.github.com/repos/mgred/lolex/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mgred/lolex/merges","archive_url":"https://api.github.com/repos/mgred/lolex/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mgred/lolex/downloads","issues_url":"https://api.github.com/repos/mgred/lolex/issues{/number}","pulls_url":"https://api.github.com/repos/mgred/lolex/pulls{/number}","milestones_url":"https://api.github.com/repos/mgred/lolex/milestones{/number}","notifications_url":"https://api.github.com/repos/mgred/lolex/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mgred/lolex/labels{/name}","releases_url":"https://api.github.com/repos/mgred/lolex/releases{/id}","deployments_url":"https://api.github.com/repos/mgred/lolex/deployments","created_at":"2018-09-04T15:27:35Z","updated_at":"2018-10-18T11:20:40Z","pushed_at":"2018-10-31T07:55:05Z","git_url":"git://github.com/mgred/lolex.git","ssh_url":"git@github.com:mgred/lolex.git","clone_url":"https://github.com/mgred/lolex.git","svn_url":"https://github.com/mgred/lolex","homepage":null,"size":1083,"stargazers_count":0,"watchers_count":0,"language":"JavaScript","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"bsd-3-clause","name":"BSD 3-Clause \"New\" or \"Revised\" License","spdx_id":"BSD-3-Clause","url":"https://api.github.com/licenses/bsd-3-clause","node_id":"MDc6TGljZW5zZTU="},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"sinonjs:master","ref":"master","sha":"85af11d97deaafa8420330eb23e363769d0088e4","user":{"login":"sinonjs","id":6570253,"node_id":"MDEyOk9yZ2FuaXphdGlvbjY1NzAyNTM=","avatar_url":"https://avatars3.githubusercontent.com/u/6570253?v=4","gravatar_id":"","url":"https://api.github.com/users/sinonjs","html_url":"https://github.com/sinonjs","followers_url":"https://api.github.com/users/sinonjs/followers","following_url":"https://api.github.com/users/sinonjs/following{/other_user}","gists_url":"https://api.github.com/users/sinonjs/gists{/gist_id}","starred_url":"https://api.github.com/users/sinonjs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sinonjs/subscriptions","organizations_url":"https://api.github.com/users/sinonjs/orgs","repos_url":"https://api.github.com/users/sinonjs/repos","events_url":"https://api.github.com/users/sinonjs/events{/privacy}","received_events_url":"https://api.github.com/users/sinonjs/received_events","type":"Organization","site_admin":false},"repo":{"id":16523712,"node_id":"MDEwOlJlcG9zaXRvcnkxNjUyMzcxMg==","name":"lolex","full_name":"sinonjs/lolex","private":false,"owner":{"login":"sinonjs","id":6570253,"node_id":"MDEyOk9yZ2FuaXphdGlvbjY1NzAyNTM=","avatar_url":"https://avatars3.githubusercontent.com/u/6570253?v=4","gravatar_id":"","url":"https://api.github.com/users/sinonjs","html_url":"https://github.com/sinonjs","followers_url":"https://api.github.com/users/sinonjs/followers","following_url":"https://api.github.com/users/sinonjs/following{/other_user}","gists_url":"https://api.github.com/users/sinonjs/gists{/gist_id}","starred_url":"https://api.github.com/users/sinonjs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sinonjs/subscriptions","organizations_url":"https://api.github.com/users/sinonjs/orgs","repos_url":"https://api.github.com/users/sinonjs/repos","events_url":"https://api.github.com/users/sinonjs/events{/privacy}","received_events_url":"https://api.github.com/users/sinonjs/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/sinonjs/lolex","description":"Fake setTimeout and friends (collectively known as \"timers\"). Useful in your JavaScript tests. Extracted from Sinon.JS","fork":false,"url":"https://api.github.com/repos/sinonjs/lolex","forks_url":"https://api.github.com/repos/sinonjs/lolex/forks","keys_url":"https://api.github.com/repos/sinonjs/lolex/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sinonjs/lolex/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sinonjs/lolex/teams","hooks_url":"https://api.github.com/repos/sinonjs/lolex/hooks","issue_events_url":"https://api.github.com/repos/sinonjs/lolex/issues/events{/number}","events_url":"https://api.github.com/repos/sinonjs/lolex/events","assignees_url":"https://api.github.com/repos/sinonjs/lolex/assignees{/user}","branches_url":"https://api.github.com/repos/sinonjs/lolex/branches{/branch}","tags_url":"https://api.github.com/repos/sinonjs/lolex/tags","blobs_url":"https://api.github.com/repos/sinonjs/lolex/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sinonjs/lolex/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sinonjs/lolex/git/refs{/sha}","trees_url":"https://api.github.com/repos/sinonjs/lolex/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sinonjs/lolex/statuses/{sha}","languages_url":"https://api.github.com/repos/sinonjs/lolex/languages","stargazers_url":"https://api.github.com/repos/sinonjs/lolex/stargazers","contributors_url":"https://api.github.com/repos/sinonjs/lolex/contributors","subscribers_url":"https://api.github.com/repos/sinonjs/lolex/subscribers","subscription_url":"https://api.github.com/repos/sinonjs/lolex/subscription","commits_url":"https://api.github.com/repos/sinonjs/lolex/commits{/sha}","git_commits_url":"https://api.github.com/repos/sinonjs/lolex/git/commits{/sha}","comments_url":"https://api.github.com/repos/sinonjs/lolex/comments{/number}","issue_comment_url":"https://api.github.com/repos/sinonjs/lolex/issues/comments{/number}","contents_url":"https://api.github.com/repos/sinonjs/lolex/contents/{+path}","compare_url":"https://api.github.com/repos/sinonjs/lolex/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sinonjs/lolex/merges","archive_url":"https://api.github.com/repos/sinonjs/lolex/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sinonjs/lolex/downloads","issues_url":"https://api.github.com/repos/sinonjs/lolex/issues{/number}","pulls_url":"https://api.github.com/repos/sinonjs/lolex/pulls{/number}","milestones_url":"https://api.github.com/repos/sinonjs/lolex/milestones{/number}","notifications_url":"https://api.github.com/repos/sinonjs/lolex/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sinonjs/lolex/labels{/name}","releases_url":"https://api.github.com/repos/sinonjs/lolex/releases{/id}","deployments_url":"https://api.github.com/repos/sinonjs/lolex/deployments","created_at":"2014-02-04T19:57:17Z","updated_at":"2018-10-25T10:04:44Z","pushed_at":"2018-10-31T07:55:07Z","git_url":"git://github.com/sinonjs/lolex.git","ssh_url":"git@github.com:sinonjs/lolex.git","clone_url":"https://github.com/sinonjs/lolex.git","svn_url":"https://github.com/sinonjs/lolex","homepage":null,"size":643,"stargazers_count":352,"watchers_count":352,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":55,"mirror_url":null,"archived":false,"open_issues_count":12,"license":{"key":"bsd-3-clause","name":"BSD 3-Clause \"New\" or \"Revised\" License","spdx_id":"BSD-3-Clause","url":"https://api.github.com/licenses/bsd-3-clause","node_id":"MDc6TGljZW5zZTU="},"forks":55,"open_issues":12,"watchers":352,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/sinonjs/lolex/pulls/221"},"html":{"href":"https://github.com/sinonjs/lolex/pull/221"},"issue":{"href":"https://api.github.com/repos/sinonjs/lolex/issues/221"},"comments":{"href":"https://api.github.com/repos/sinonjs/lolex/issues/221/comments"},"review_comments":{"href":"https://api.github.com/repos/sinonjs/lolex/pulls/221/comments"},"review_comment":{"href":"https://api.github.com/repos/sinonjs/lolex/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/sinonjs/lolex/pulls/221/commits"},"statuses":{"href":"https://api.github.com/repos/sinonjs/lolex/statuses/bcc0660439fc150a04f60289195761932dbb14ce"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"mgred"}}