Skip to content

Commit

Permalink
Add more links
Browse files Browse the repository at this point in the history
  • Loading branch information
ehmicky committed Mar 7, 2019
1 parent e0f8665 commit 9aa1528
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This library can also perform operations on Unix permissions such as:

- [testing](docs/API.md#containpermission-permissions),
[setting](docs/API.md#setpermission-permissions) and
[unsetting](docs/API.md#notpermission-permissions). Using bitwise operations
[unsetting](docs/API.md#notpermission). Using bitwise operations
(`|`, `&`, `^`, `~`) can be tedious and error-prone otherwise.
- [validating](docs/API.md#normalizepermission) syntax.
- [normalizing](docs/API.md#normalizepermission). For example `u+r,u+w` can be
Expand Down Expand Up @@ -122,49 +122,49 @@ Please see the [types full documentation](docs/types.md).
Please see the [methods full documentation](docs/API.md) for more information
and examples.

## convert.octal|number|stat|symbolic|object(permission)
## [convert.octal|number|stat|symbolic|object(permission)](API.md#convertoctalnumberstatsymbolicobjectpermission)

Convert `permission` to another type.

## type(permission)
## [type(permission)](API.md#typepermission)

Returns the `permission`'s type or `invalid`.

## normalize(permission)
## [normalize(permission)](API.md#normalizepermission)

Normalize a `permission` to its canonical shape. Throw if `permission` is
invalid.

## positive(permission)
## [positive(permission)](API.md#positivepermission)

Remove all negative permissions.

## contain(permission, permissions...)
## [contain(permission, permissions...)](API.md#containpermission-permissions)

Tests whether `permission` includes `permissions`.

## equal(permission, permissions...)
## [equal(permission, permissions...)](API.md#equalpermission-permissions)

Tests whether `permission` equals exactly `permissions`.

## set(permission, permissions...)
## [set(permission, permissions...)](API.md#setpermission-permissions)

Set `permissions` on `permission`. This is useful to avoid error-prone bitwise
operations (`|`, `&`, `^`, `~`).

## not(permission)
## [not(permission)](API.md#notpermission)

Inverts `permission` including special permissions. This can be used in
combination with `set()` to unset `permissions` instead of setting them.

## invert(permission)
## [invert(permission)](API.md#invertpermission)

Inverts `permission` and removes special permissions.

## min(permissions...)
## [min(permissions...)](API.md#minpermissions)

Retrieve the lowest permissions among all arguments.

## max(permissions...)
## [max(permissions...)](API.md#maxpermissions)

Retrieve the highest permissions among all arguments.

0 comments on commit 9aa1528

Please sign in to comment.