mirror of
https://github.com/MontFerret/ferret.git
synced 2025-11-25 22:01:39 +02:00
Rewrite comments, closing #118
This commit is contained in:
@@ -2,18 +2,17 @@ package arrays
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/MontFerret/ferret/pkg/runtime/core"
|
||||
"github.com/MontFerret/ferret/pkg/runtime/values"
|
||||
)
|
||||
|
||||
/*
|
||||
* Prepends value to a given array.
|
||||
* @param array (Array) - Target array.
|
||||
* @param value (Read) - Target value to prepend.
|
||||
* @param unique (Boolean, optional) - Optional value indicating whether a value must be unique to be prepended.
|
||||
* Default is false.
|
||||
* @returns (Array) - New array with prepended value.
|
||||
*/
|
||||
// Unshift prepends value to a given array.
|
||||
// @param array (Array) - Target array.
|
||||
// @param value (Read) - Target value to prepend.
|
||||
// @param unique (Boolean, optional) - Optional value indicating whether a value must be unique to be prepended.
|
||||
// Default is false.
|
||||
// @returns (Array) - New array with prepended value.
|
||||
func Unshift(_ context.Context, args ...core.Value) (core.Value, error) {
|
||||
err := core.ValidateArgs(args, 2, 3)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user