Function filterNotifications

  • filterNotifications(
        notifications: {
            commands?: string[];
            cta?: { label: string; url: string };
            frequency: "always" | "once" | "once_a_day" | "once_a_week";
            id: string;
            maxDate?: string;
            maxVersion?: string;
            message: string;
            minDate?: string;
            minVersion?: string;
            ownerChannel: string;
            surface?: string;
            title?: string;
            type: "error" | "info" | "warning";
        }[],
        commandId: string,
        currentSurfaces?: string[],
        today?: Date,
        currentVersion?: string,
    ): {
        commands?: string[];
        cta?: { label: string; url: string };
        frequency: "always" | "once" | "once_a_day" | "once_a_week";
        id: string;
        maxDate?: string;
        maxVersion?: string;
        message: string;
        minDate?: string;
        minVersion?: string;
        ownerChannel: string;
        surface?: string;
        title?: string;
        type: "error" | "info" | "warning";
    }[]

    Filters notifications based on the version of the CLI.

    Parameters

    • notifications: {
          commands?: string[];
          cta?: { label: string; url: string };
          frequency: "always" | "once" | "once_a_day" | "once_a_week";
          id: string;
          maxDate?: string;
          maxVersion?: string;
          message: string;
          minDate?: string;
          minVersion?: string;
          ownerChannel: string;
          surface?: string;
          title?: string;
          type: "error" | "info" | "warning";
      }[]

      The notifications to filter.

    • commandId: string

      The command ID to filter by.

    • OptionalcurrentSurfaces: string[]

      The surfaces present in the current project (usually for app extensions).

    • today: Date = ...

      The current date.

    • currentVersion: string = CLI_KIT_VERSION

      The current version of the CLI.

    Returns {
        commands?: string[];
        cta?: { label: string; url: string };
        frequency: "always" | "once" | "once_a_day" | "once_a_week";
        id: string;
        maxDate?: string;
        maxVersion?: string;
        message: string;
        minDate?: string;
        minVersion?: string;
        ownerChannel: string;
        surface?: string;
        title?: string;
        type: "error" | "info" | "warning";
    }[]

    • The filtered notifications.

Settings

Member Visibility