What it does
Creates a new List or String containing a subset (slice) of the elements.
How to use
array_or_string_expression | slice:start[:end]
NgModule
CommonModule
Description
Where the input expression is a List
or String
, and:
start
: The starting index of the subset to return.- a positive integer: return the item at
start
index and all items after in the list or string expression. - a negative integer: return the item at
start
index from the end and all items after in the list or string expression. - if positive and greater than the size of the expression: return an empty list or string.
- if negative and greater than the size of the expression: return entire list or string.
- a positive integer: return the item at
end
: The ending index of the subset to return.- omitted: return all items until the end.
- if positive: return all items before
end
index of the list or string. - if negative: return all items before
end
index from the end of the list or string.
All behavior is based on the expected behavior of the JavaScript API Array.prototype.slice()
and String.prototype.slice()
.
When operating on a [List], the returned list is always a copy even when all the elements are being returned.
When operating on a blank value, the pipe returns the blank value.
List Example
This ngFor
example:
produces the following:
<li>b</li>
<li>c</li>
String Examples
exported from common/index defined in common/src/pipes/slice_pipe.ts