From 9735ed655d175556fcf747a022a8f1db30739772 Mon Sep 17 00:00:00 2001 From: Ankit Mahato Date: Sun, 29 Jun 2025 06:38:48 +0530 Subject: [PATCH] Update README.md --- packages/better_networking/README.md | 74 +++++++++++++++++++++++++++- 1 file changed, 73 insertions(+), 1 deletion(-) diff --git a/packages/better_networking/README.md b/packages/better_networking/README.md index 400c9425..45a3d324 100644 --- a/packages/better_networking/README.md +++ b/packages/better_networking/README.md @@ -1 +1,73 @@ -## better_networking \ No newline at end of file +## better_networking + + +### Making HTTP Requests + +```dart +import 'package:better_networking/better_networking.dart'; + +final (resp, duration, err) = await sendHttpRequest( + 'Request1', + APIType.rest, + HttpRequestModel( + url: 'https://example.com', + method: HTTPVerb.post, + headers: [ + NameValueModel( + name: 'x-api-key', + value: 'AeAze8493ufhd9....', + ), + ], + params: [NameValueModel(name: 'version', value: 'v1')], + query: 'users', + body: jsonEncode({"name": "morpheus", "job": "leader"}), + formData: [ + FormDataModel( + name: 'name', + value: 'morpheus', + type: FormDataType.text, + ), + ], + ), +); +//Similarly, Requests can be made for all the types of requests +``` + +### Making Streaming Requests (SSE) + +```dart +import 'package:better_networking/better_networking.dart'; + +final stream = await streamHttpRequest( + 'S1', + APIType.rest, + HttpRequestModel( + method: HTTPVerb.get, + url: 'http://example.com', + body: jsonEncode({...}), + ), +); +stream.listen( + (data) { + print('Recieved Data: $data'); + }, + onDone: () { + print('Streaming Complete'); + }, + onError: (e) { + print(e); + }, +); +``` + +### Cancelling Requests +```dart +import 'package:better_networking/better_networking.dart'; + +cancelHttpRequest('request-id'); +``` + +### Make GraphQL Requests +```dart +APIType.graphql +```