Insert Before¶

Description¶

This operation inserts a new value before an existing value in a list.

Method¶

Backendless.Hive(hiveName).ListStore(keyName).insertBefore(valueToInsert, anchorValue): Promise<number>;

where:

Argument	Description
`hiveName`	Name of a hive where the operation is performed. String value.
`keyName`	Key name identifying a list. String value.
`valueToInsert`	New value to insert into the list. Can be of any data type.
`anchorValue`	Value which is used as a position anchor. Can be of any data type.

Return Value¶

The number of values in the list after the insertion operation.

Example¶

The example below inserts the 'Apple' item right before the 'Orange' item in the 'fruits' list.

await Backendless.Hive('groceryStore').ListStore('fruits').insertBefore('Apple', 'Orange')

where:

Argument	Description
`'groceryStore'`	Name of a hive where the operation is performed.
`'fruits'`	Key name identifying a list.

Codeless Reference¶

list_api_insert_before

where:

Argument	Description
`hive name`	Name of a hive where the operation is performed.
`key name`	Key name identifying a list.
`item`	New item to insert into the list.
`before item`	Value which is used as a position anchor.

Returns he number of values in the list after the insertion operation.

Consider the following List storage:

list_api_example_insert_before_2

The example below inserts the value "Apple" before the "Orange" item in a list identified by the "fruits" key name:
list_api_example_insert_before

The list storage will look as shown below after the Codeless logic runs:
list_api_example_get_values_2