Skip to content

notify ​

notify solicita uma notificação nativa do sistema e retorna um erro estruturado se o serviço da plataforma não conseguir exibi-la.

Assinaturanotify(title: string, body: string, options?: NotifyOptions): Result<void, OsError>
tyrus
import { NotifyOptions, NotifyUrgency, OsError, notify } from "tyrus:os";

const main = (): void => {
    match (notify("Build complete", "All 42 tests passed.")) {
        Ok() => print("Notification sent"); // Notification sent
        Err(error) => printError(`${error.code}: ${error.message}`); // ERR_OS_NOTIFICATION_FAILED: the platform notification service could not show the notification
    }

    const options: NotifyOptions = { urgency: NotifyUrgency.Critical, timeout: 5000 };
    match (notify("Build failed", "3 tests failed.", options)) {
        Ok() => print("Critical notification sent"); // Critical notification sent
        Err(error) => printError(`${error.code}: ${error.message}`); // ERR_OS_NOTIFICATION_FAILED: the platform notification service could not show the notification
    }
};

options assume os padrões da própria plataforma para cada campo quando omitido.

Campos de NotifyOptions ​

CampoTipoSignificado
iconstring?O nome ou caminho de um ícone para mostrar junto da notificação.
urgencyNotifyUrgency?Veja NotifyUrgency. Padrão é Normal.
timeoutu32?Por quanto tempo a notificação fica visível, em milissegundos, antes do ambiente de desktop dispensá-la automaticamente.

Membros de NotifyUrgency ​

MembroSignificado
LowPrioridade baixa, o ambiente de desktop pode nem mostrar em modo "não perturbe".
NormalPrioridade padrão.
CriticalPrioridade alta, alguns ambientes de desktop mantêm na tela até ser dispensada.

Retorna Err(OsError) com o código ERR_OS_NOTIFICATION_FAILED quando o serviço de notificações da plataforma está indisponível ou recusa a notificação. Um título ou corpo nulo retorna ERR_OS_INVALID_ARGUMENT.

Campos de OsError ​

CampoTipoSignificado
codestringUm identificador de erro estável e legível por máquina.
messagestringUma descrição legível da falha.
:::