@gj-kit/nest-notifications API

This reference is generated from the 0.1.1 release declaration snapshot. Unpublished main APIs are not shown.

`Root entry`

Import: @gj-kit/nest-notifications

Symbol	Kind
`AppendItemInput`	interface
`BatchIdentity`	interface
`ClaimedNotificationCommand`	interface
`ClaimedNotificationDelivery`	interface
`CreateDeliveryInput`	interface
`CreateDeliveryResult`	interface
`DispatchClaimRequest`	interface
`DispatchCompleteRequest`	interface
`DispatchReleaseRequest`	interface
`DispatchTransactionRequest`	interface
`EnsureMessageInput`	interface
`fromNestLogger`	function
`MergeBatchInput`	interface
`NestNotificationsAsyncOptions`	interface
`NestNotificationsModule`	class
`NestNotificationsOptions`	interface
`NOTIFICATION_APPLICATION_KEY`	constant
`NOTIFICATION_DELIVERY_STORE`	constant
`NOTIFICATION_ENDPOINT_STORE`	constant
`NOTIFICATION_LOGGER`	constant
`NOTIFICATION_PIPELINE_WAKEUP`	constant
`NOTIFICATION_PRESENTER`	constant
`NOTIFICATION_PUBLISHER`	constant
`NOTIFICATION_PUSH_GATEWAY`	constant
`NOTIFICATION_RELAY_STORE`	constant
`NOTIFICATION_RUNTIME`	constant
`NOTIFICATION_SCHEDULING_POLICY`	constant
`NotificationAccountLifecycle`	interface
`NotificationAction`	type
`NotificationBatch`	interface
`NotificationBatchWindow`	interface
`NotificationClock`	interface
`NotificationCommand`	interface
`NotificationDeliveryStore`	interface
`NotificationDispatcher`	interface
`NotificationDispatcherOptions`	interface
`NotificationDispatchRunner`	class
`NotificationDispatchSummary`	type
`NotificationDispatchTransaction`	interface
`NotificationEndpointDisableTarget`	interface
`NotificationEndpointStore`	interface
`NotificationJsonPrimitive`	type
`NotificationJsonValue`	type
`NotificationLogger`	interface
`NotificationPipelineWakeup`	interface
`NotificationPresentation`	interface
`NotificationPresentationInput`	interface
`NotificationPresenter`	interface
`NotificationPriority`	type
`NotificationPublisher`	interface
`NotificationPushEndpoint`	interface
`NotificationPushGateway`	interface
`NotificationPushPayload`	interface
`NotificationPushResult`	interface
`NotificationQuietHours`	interface
`NotificationRecipientLiveness`	interface
`NotificationRelay`	interface
`NotificationRelayOptions`	interface
`NotificationRelayOutcome`	type
`NotificationRelayRunner`	class
`NotificationRelayStore`	interface
`NotificationRelaySummary`	type
`NotificationRelayTransaction`	interface
`NotificationSchedulingPolicy`	interface
`NotificationsError`	type
`NotificationsErrorCode`	type
`NotificationStageResult`	interface
`NotificationTiming`	type
`NotificationWakeupOptions`	interface
`ObservedNotificationEndpoint`	interface
`OpenBatchDelivery`	interface
`QuietHoursPolicyOptions`	interface
`RelayClaimRequest`	interface
`RelayCompleteRequest`	interface
`RelayReleaseRequest`	interface
`RelayTransactionRequest`	interface
`ResolveDeliveryInput`	interface

`./core`

Import: @gj-kit/nest-notifications/core

Symbol	Kind
`AppendItemInput`	interface
`assertNotificationCommand`	function
`BatchIdentity`	interface
`ClaimedNotificationCommand`	interface
`ClaimedNotificationDelivery`	interface
`CreateDeliveryInput`	interface
`CreateDeliveryResult`	interface
`createNotificationDispatcher`	function
`createNotificationRelay`	function
`createNotificationWakeup`	function
`createQuietHoursPolicy`	function
`DEFAULT_BATCH_WINDOW_MS`	constant
`DEFAULT_CLAIM_STALE_MS`	constant
`DEFAULT_DISPATCH_PAGE_SIZE`	constant
`DEFAULT_RELAY_PAGE_SIZE`	constant
`DispatchClaimRequest`	interface
`DispatchCompleteRequest`	interface
`DispatchReleaseRequest`	interface
`DispatchTransactionRequest`	interface
`EnsureMessageInput`	interface
`isNotificationsError`	function
`MergeBatchInput`	interface
`NotificationAccountLifecycle`	interface
`NotificationAction`	type
`NotificationBatch`	interface
`notificationBatchPolicyKey`	function
`NotificationBatchWindow`	interface
`NotificationClock`	interface
`NotificationCommand`	interface
`NotificationDeliveryStore`	interface
`NotificationDispatcher`	interface
`NotificationDispatcherOptions`	interface
`NotificationDispatchSummary`	type
`NotificationDispatchTransaction`	interface
`NotificationEndpointDisableTarget`	interface
`NotificationEndpointStore`	interface
`notificationFollowUpBatchPolicyKey`	function
`NotificationJsonPrimitive`	type
`NotificationJsonValue`	type
`NotificationLogger`	interface
`NotificationPipelineWakeup`	interface
`NotificationPresentation`	interface
`NotificationPresentationInput`	interface
`NotificationPresenter`	interface
`NotificationPriority`	type
`notificationPriorityFrom`	function
`NotificationPublisher`	interface
`NotificationPushEndpoint`	interface
`NotificationPushGateway`	interface
`NotificationPushPayload`	interface
`NotificationPushResult`	interface
`NotificationQuietHours`	interface
`notificationRecipientKey`	function
`NotificationRecipientLiveness`	interface
`NotificationRelay`	interface
`NotificationRelayOptions`	interface
`NotificationRelayOutcome`	type
`NotificationRelayStore`	interface
`NotificationRelaySummary`	type
`NotificationRelayTransaction`	interface
`NotificationRuntime`	interface
`NotificationSchedulingPolicy`	interface
`NotificationsError`	class
`NotificationsErrorCode`	type
`NotificationStageResult`	interface
`NotificationTiming`	type
`NotificationWakeupOptions`	interface
`ObservedNotificationEndpoint`	interface
`OpenBatchDelivery`	interface
`QuietHoursPolicyOptions`	interface
`RelayClaimRequest`	interface
`RelayCompleteRequest`	interface
`RelayReleaseRequest`	interface
`RelayTransactionRequest`	interface
`ResolveDeliveryInput`	interface
`safeErrorCode`	function
`silentNotificationLogger`	function
`systemNotificationRuntime`	function

`./expo`

Import: @gj-kit/nest-notifications/expo

Symbol	Kind
`chunkExpoPushMessages`	function
`classifyExpoPushTickets`	function
`createExpoPushGateway`	function
`EXPO_DEVICE_NOT_REGISTERED`	constant
`EXPO_PUSH_CHUNK_SIZE`	constant
`ExpoPushEntry`	interface
`ExpoPushGatewayOptions`	interface
`ExpoPushMessage`	interface
`ExpoPushTicket`	type
`ExpoTicketClassification`	interface
`isExpoPushToken`	function

`./testing`

Import: @gj-kit/nest-notifications/testing

Symbol	Kind
`fakeNotificationRuntime`	function
`FakeNotificationRuntime`	interface
`LogEntry`	interface
`MemoryNotificationSnapshot`	interface
`memoryNotificationStores`	function
`MemoryNotificationStores`	interface
`NotificationObligation`	type
`notificationStoreContractCases`	function
`NotificationStoreContractOptions`	interface
`NotificationStoreSuite`	interface
`passthroughPresenter`	function
`recordingNotificationLogger`	function
`RecordingNotificationLogger`	interface
`StoreContractCase`	interface