danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-26 20:34:47 +01:00
Code Issues Projects Releases Wiki Activity

Indent other types

Browse Source
This commit is contained in:
Matthew Brown 2019-06-09 17:20:13 -04:00 committed by GitHub
parent c0a9ccb385
commit 30b1b0a65c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/annotating_code/docblock_type_syntax.md
View File

@ -63,31 +63,12 @@ A type without unions is an atomic type. Psalm allows many different sorts of ba
### Other
#### iterable
Represents the [`iterable` pseudo-type](https://php.net/manual/en/language.types.iterable.php).
Like arrays, iterables can have type parameters e.g. `iterable<string, Foo>`.
#### void
`void` can be used in a return type when a function does not return a value.
#### empty
`empty` is a type that represents a lack of type - not just a lack of type information (that's where [mixed](#mixed) is useful) but where there can be no type. A good example is the type of the empty array `[]`. Psalm types this as `array<empty, empty>`.
#### mixed
`mixed` represents a lack of type information. Psalm warns about mixed when the `totallyTyped` flag is turned on.
#### resource
`resource` represents a [PHP resource](https://www.php.net/manual/en/language.types.resource.php).
#### no-return
`no-return` is the 'return type' for a function that can never actually return, such as `die()`, `exit()`, or a function that
- `iterable` - represents the [`iterable` pseudo-type](https://php.net/manual/en/language.types.iterable.php). Like arrays, iterables can have type parameters e.g. `iterable<string, Foo>`.
- `void` - can be used in a return type when a function does not return a value.
- `empty` - a type that represents a lack of type - not just a lack of type information (that's where [mixed](#mixed) is useful) but where there can be no type. A good example is the type of the empty array `[]`. Psalm types this as `array<empty, empty>`.
- `mixed` represents a lack of type information. Psalm warns about mixed when the `totallyTyped` flag is turned on.
- `resource` represents a [PHP resource](https://www.php.net/manual/en/language.types.resource.php).
- `no-return` is the 'return type' for a function that can never actually return, such as `die()`, `exit()`, or a function that
always throws an exception. It may also be written as `never-return` or `never-returns`, and is also known as the *bottom type*.
## Intersection types