Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ehmicky committed Dec 29, 2018
1 parent defd8c8 commit be987be
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,8 +280,8 @@ unixPermissions.partial(unixPermissions.invert('660')) // '0117'

## `contains(permission, permissions...)`

Returns `true` or `false` depending on whether `permissions` are contained
within `permission`. On the CLI use exit code `0` or `1` instead.
Returns `true` or `false` depending on whether `permission` includes
`permissions`. On the CLI the exit code `0` or `1` is used instead.

`permission` is first internally converted using
[`full(permission)`](#fullpermission).
Expand All @@ -303,7 +303,7 @@ unixPermissions.contains('o+x,o-w', 'o+x', 'o-w') // `true`

Returns the result of setting `permissions` on `permission`.

This is useful to avoid bitwise operations.
This is useful to avoid error-prone bitwise operations.

This can also be used to remove special permissions using
`set(permission, 'a-st')` since some functions like
Expand All @@ -316,6 +316,7 @@ unixPermissions.set('---------', 'a+x') // '--x--x--x'
unixPermissions.set('---------', 'a+x', 'a+r') // 'r-xr-xr-x'
unixPermissions.set('--x--x--x', 'o-x') // '--x--x---'
unixPermissions.set('a+x', 'a+r') // 'a+rx'
unixPermissions.set('4660', 'a-st') // '=0660'
```

## `unset(permission, permissions...)`
Expand Down

0 comments on commit be987be

Please sign in to comment.