From 5cb54a411fee2e76843293fb2b86f97159905149 Mon Sep 17 00:00:00 2001 From: Mikhail Chechnev Date: Fri, 1 Dec 2023 19:19:15 +0300 Subject: [PATCH] =?UTF-8?q?=D0=98=D0=BD=D1=81=D1=82=D1=80=D1=83=D0=BA?= =?UTF-8?q?=D1=86=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 48 ++++++++++++++++++------------------------------ 1 file changed, 18 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 37f8aa8..df46fcb 100644 --- a/README.md +++ b/README.md @@ -242,25 +242,25 @@ c:\inetpub\p8web20\WebClient\Modules\P8-Panels>npm run build Где: -- `SSTATUS` - состояние исполнения (`"OK"` или `"ERR"`) -- `XPAYLOAD` - полезная нагрузка, данные полученные от серверного объекта -- `SMESSAGE` - текст сообщения об ошибке +- `SSTATUS` - строка, состояние исполнения (`"OK"` - успех или `"ERR"` - ошибка) +- `XPAYLOAD` - объект, полезная нагрузка, данные полученные от серверного объекта (отсутствует, если `SSTATUS = "ERR"`) +- `SMESSAGE` - строка, текст сообщения об ошибке (отсутствует, если `SSTATUS = "OK"`) #### `boolean isRespErr(Object)` -**Входные параметры:** результат вызова `executeStored` +**Входные параметры:** обязательный, объект, результат вызова `executeStored` **Результат:** `true` - если полученный на вход результат исполнения `executeStored` содержит ошибку, `false` - в остальных случаях #### `String getRespErrMessage(Object)` -**Входные параметры:** результат вызова `executeStored` +**Входные параметры:** обязательный, объект, результат вызова `executeStored` **Результат:** текст сообщения об ошибке - если полученный на вход результат исполнения `executeStored` содержит ошибку, пустая строка (`""`) - в остальных случаях #### `Object getRespPayload(Object)` -**Входные параметры:** результат вызова `executeStored` (вызов должен осуществляться с параметром `fullResponse = true`) +**Входные параметры:** обязательный, объект, результат вызова `executeStored` (вызов должен осуществляться с параметром `fullResponse = true`) **Результат:** объект с данными, размещёнными в `XPAYLOAD` ответа сервера - если полученный на вход результат исполнения `executeStored` содержит полезную нагрузку, `null` - в остальных случаях @@ -289,10 +289,12 @@ c:\inetpub\p8web20\WebClient\Modules\P8-Panels>npm run build `args` - необязательный, объект, описание параметров исполняемого хранимого объета вида: `{"ПАРАМЕТР": "ЗНАЧЕНИЕ"|{VALUE: "ЗНАЧЕНИЕ", SDATA_TYPE: SERV_DATA_TYPE_*}}` (если тип данных параметров не указан явно - произойдёт попытка их автоматического определения, с CLOB-параметрами это не всегда может произойти корректно)\ `respArg` - необязательный, строка, имя выходного параметра исполняемого объекта, значение которого необходимо вернуть как данные ответа (если не указан - возвращвется типовой ответ)\ `isArray`, `tagValueProcessor`, `attributeValueProcessor` - необязательны, функции, позволяющие провести корректировку парсинга XML-ответа сервера в JSON (сигнатура и назначение функций описаны в документации к [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser/blob/HEAD/docs/v4/2.XMLparseOptions.md))\ -`loader` - отображать типовой индикатор процесса\ -`loaderMessage` - текст индикатора процесса (при отсутствии будет использован типовой)\ -`throwError` - признак генерации исключения, если false - возвращает ошибку в типовом формате\ -`showErrorMessage` - отображать типовое клиентское сообщение об ошибке, в случае её возникновения (только если `throwError = true`) +`loader` - необязательный, логический, признак отображения типового индикатора процесса\ +`loaderMessage` - необязательный, строка, текст индикатора процесса (при отсутствии будет использован типовой)\ +`throwError` - необязательный, логический, признак генерации исключения, если `false` - возвращает ошибку в типовом формате\ +`showErrorMessage` - необязательный, логический, признак отображения типового клиентского сообщение об ошибке, в случае её возникновения (только если `throwError = true`)\ +`fullResponse` - необязательный, логический, признак возврата полного типового ответа сервера, если `false` - возвращается только содержимое `XPAYLOAD`\ +`spreadOutArguments` - необязательный, логический, признак "разделения" значений выходных параметров исполняемого обхекта (игнорируется при наличии `respArg`), если `true` - `XPAYLOAD` будет содержать ответ в виде `{"ВЫХОДНОЙ_ПАРАМЕТР1": "ЗНАЧЕНИЕ", "ВЫХОДНОЙ_ПАРАМЕТР2": "ЗНАЧЕНИЕ", ...}`, если `false` - `XPAYLOAD` будет содержать ответ в виде `{XOUT_ARGUMENTS: [{SNAME: "ВЫХОДНОЙ_ПАРАМЕТР1", VALUE: "ЗНАЧЕНИЕ"}, {SNAME: "ВЫХОДНОЙ_ПАРАМЕТР2", VALUE: "ЗНАЧЕНИЕ"}, ...]}` **Результат:** объект с данными, размещёнными в `XPAYLOAD` ответа сервера (если `fullResponse = false`) или полный типовой ответ (описан выше). @@ -305,12 +307,7 @@ import { BackEndСtx } from "../../context/backend"; //Контекст взаи //Функциональный компонент панели (или её части) const MyPanel = () => { //Собственное состояние - const [state, setState] = useState({ - dataLoaded: false, - data: [], - filters: null, - orders: null - }); + const [state, setState] = useState({ dataLoaded: false, data: [], filters: null, orders: null }); //Подключение к контексту взаимодействия с сервером const { executeStored, SERV_DATA_TYPE_CLOB } = useContext(BackEndСtx); @@ -347,21 +344,12 @@ const MyPanel = () => { } ``` -`loader` - отображать типовой индикатор процесса\ -`loaderMessage` - текст индикатора процесса (при отсутствии будет использован типовой)\ -`throwError` - признак генерации исключения, если false - возвращает ошибку в типовом формате\ -`showErrorMessage` - отображать типовое клиентское сообщение об ошибке, в случае её возникновения (только если `throwError = true`) +`loader` - необязательный, логический, признак отображения типового индикатора процесса\ +`loaderMessage` - необязательный, строка, текст индикатора процесса (при отсутствии будет использован типовой)\ +`throwError` - необязательный, логический, признак генерации исключения, если `false` - возвращает ошибку в типовом формате\ +`showErrorMessage` - необязательный, логический, признак отображения типового клиентского сообщения об ошибке, в случае её возникновения (только если `throwError = true`) -**Результат:** - -``` -{ - SSTATUS: "OK", - XPAYLOAD: JSON-представление файла конфигурации -} -``` - -где `XPAYLOAD` объект вида (см. описание атрибутов выше, в описании "p8panels.config"): +**Результат:** объект, типовой ответ, где `XPAYLOAD` объект вида (см. описание атрибутов выше, в описании "p8panels.config"): ``` {