Skip to content

Commit e952c74

Browse files
committed
doc fix
1 parent a0e18f7 commit e952c74

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ See [contributing guide](.github/CONTRIBUTING.md)
143143

144144
| Date | Version | Description |
145145
| ----------- | ------- | ----------- |
146+
| 2018-06-25 | v1.0.29 | Maintenance |
146147
| 2018-06-25 | v1.0.28 | Expose webNotification.requestPermission #5 |
147148
| 2018-06-14 | v1.0.26 | Better error detection on chrome mobile #4 |
148149
| 2017-08-25 | v1.0.21 | Support service worker web notifications |

docs/api.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ A simplified web notification API.
2828
* [webNotification](#webNotification) : <code>object</code>
2929
* [.allowRequest](#webNotification.allowRequest) : <code>Boolean</code>
3030
* [.permissionGranted](#webNotification.permissionGranted)
31-
* [.requestPermission([callback])](#webNotification.requestPermission)
31+
* [.requestPermission(callback)](#webNotification.requestPermission)
3232
* [.showNotification([title], [options], [callback])](#webNotification.showNotification)
3333

3434
<a name="webNotification.allowRequest"></a>
@@ -45,14 +45,14 @@ True if permission is granted, else false.
4545
**Access**: public
4646
<a name="webNotification.requestPermission"></a>
4747

48-
### webNotification.requestPermission([callback])
48+
### webNotification.requestPermission(callback)
4949
Triggers the request permissions dialog in case permissions were not already granted.
5050

5151
**Access**: public
5252

5353
| Param | Type | Description |
5454
| --- | --- | --- |
55-
| [callback] | [<code>PermissionsRequestCallback</code>](#PermissionsRequestCallback) | Called with the permissions result (true enabled, false disabled) |
55+
| callback | [<code>PermissionsRequestCallback</code>](#PermissionsRequestCallback) | Called with the permissions result (true enabled, false disabled) |
5656

5757
**Example**
5858
```js
@@ -163,6 +163,5 @@ navigator.serviceWorker.register('service-worker.js').then(function(registration
163163

164164
| Param | Type | Description |
165165
| --- | --- | --- |
166-
| [error] | <code>error</code> | The error object in case of any error |
167-
| [hide] | <code>function</code> | The hide notification function |
166+
| granted | <code>Boolean</code> | True if permission is granted, else false |
168167

web-notification.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@
279279
* @memberof! webNotification
280280
* @alias webNotification.requestPermission
281281
* @public
282-
* @param {PermissionsRequestCallback} [callback] - Called with the permissions result (true enabled, false disabled)
282+
* @param {PermissionsRequestCallback} callback - Called with the permissions result (true enabled, false disabled)
283283
* @example
284284
* ```js
285285
* //manually ask for notification permissions (invoked automatically if needed and allowRequest=true)

0 commit comments

Comments
 (0)