flutter_client_sse 2.0.3 copy "flutter_client_sse: ^2.0.3" to clipboard
flutter_client_sse: ^2.0.3 copied to clipboard

Dart package to help consume SSE API. It consumes server sent events by returning parsed model of the event, id, and the data

Flutter Client SSE #

Dart package to help consume Server Sent Events

Features: #

  • Consumes server sent events
  • Returns parsed model of the event, id and the data

Getting Started #

Import #

Add the following import in the pubspec.yaml file

client_sse:
    git:
      url: https://github.com/pratikbaid3/flutter_client_sse
      path:
copied to clipboard

Example #

///GET REQUEST
SSEClient.subscribeToSSE(
    method: SSERequestType.GET,
    url:
    'http://192.168.1.2:3000/api/activity-stream?historySnapshot=FIVE_MINUTE',
    header: {
        "Cookie":
        'jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJpYXQiOjE2NDMyMTAyMzEsImV4cCI6MTY0MzgxNTAzMX0.U0aCAM2fKE1OVnGFbgAU_UVBvNwOMMquvPY8QaLD138; Path=/; Expires=Wed, 02 Feb 2022 15:17:11 GMT; HttpOnly; SameSite=Strict',
        "Accept": "text/event-stream",
        "Cache-Control": "no-cache",
    }).listen((event) {
        print('Id: ' + event.id!);
        print('Event: ' + event.event!);
        print('Data: ' + event.data!);
    },
);

///POST REQUEST
SSEClient.subscribeToSSE(
    method: SSERequestType.POST,
    url:
    'http://192.168.1.2:3000/api/activity-stream?historySnapshot=FIVE_MINUTE',
    header: {
        "Cookie":
        'jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJpYXQiOjE2NDMyMTAyMzEsImV4cCI6MTY0MzgxNTAzMX0.U0aCAM2fKE1OVnGFbgAU_UVBvNwOMMquvPY8QaLD138; Path=/; Expires=Wed, 02 Feb 2022 15:17:11 GMT; HttpOnly; SameSite=Strict',
        "Accept": "text/event-stream",
        "Cache-Control": "no-cache",
    },
    body: {
        "name": "Hello",
        "customerInfo": {"age": 25, "height": 168}
    }).listen((event) {
            print('Id: ' + event.id!);
            print('Event: ' + event.event!);
            print('Data: ' + event.data!);
    },
);
copied to clipboard

Running Sample Backend #

Nest The backend is in NestJS serving a single SSE api.

Installation #

$ yarn install
copied to clipboard

Running the app #

# development
$ yarn run start

# watch mode
$ yarn run start:dev
copied to clipboard
93
likes
150
points
108k
downloads

Publisher

verified publisherhustlecreatives.dev

Weekly Downloads

2024.09.22 - 2025.04.06

Dart package to help consume SSE API. It consumes server sent events by returning parsed model of the event, id, and the data

Repository (GitHub)

Documentation

API reference

License

MIT (license)

Dependencies

flutter, http

More

Packages that depend on flutter_client_sse