Skip to content

Opensearch dashboards.iopensearchdashboardssocket

Home > opensearch-dashboards > IOpenSearchDashboardsSocket

IOpenSearchDashboardsSocket interface

A tiny abstraction for TCP socket.

Signature:

export interface IOpenSearchDashboardsSocket 

Properties

Property Type Description
authorizationError? Error (Optional) The reason why the peer's certificate has not been verified. This property becomes available only when authorized is false.
authorized? boolean (Optional) Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is undefined.

Methods

Method Description
getPeerCertificate(detailed)
getPeerCertificate(detailed)
getPeerCertificate(detailed) Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null.