Перейти к основному контенту

searchBlock

Быстрый поиск объектов блока с ограниченным выводом. Он возвращает Promise, который разрешается в массив объектов ISearchBlock.

Описание

Blocks.searchBlock(

name, langCode

);

Схема параметров

Схема

name(обязательно): string
Строка поиска
пример: "product_block"

langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"

Примеры

Минимальный пример

const response = await Blocks.searchBlock('my-marker');

Пример с атрибутами

const response = await Blocks.searchBlock('my-marker', 'en_US');

Пример ответа

[
{
"id": 5,
"identifier": "another",
"name": "another"
},
{
"id": 2,
"identifier": "similar",
"name": "similar"
}
]

Схема ответа

Схема: ISearchBlock[]

id: number
Уникальный идентификатор поискового блока.
пример: 1

identifier: string
Уникальный строковый идентификатор для поискового блока.
пример: "search_block_1"

name: string
Название поискового блока.
пример: "Поисковый Блок 1"