.github/workflows/close-inactive-issues.yml

@@ -0,0 +1,22 @@
+name: Close inactive issues
+on:
+  schedule:
+    - cron: '30 1 * * *'
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v5
+        with:
+          days-before-issue-stale: 30
+          days-before-issue-close: 7
+          stale-issue-label: 'stale'
+          stale-issue-message: 'This issue is stale because it has been open for 30 days with no activity.'
+          close-issue-message: 'This issue was closed because it has been inactive for 7 days since being marked as stale.'
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run format
+npm run format

CHANGELOG.md

@@ -5,6 +5,62 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [4.8.4] - 2025-02-09
+
+### Changed
+
+- Updated the `options` property in the `SocketIoConfig` interface to use `Partial<ManagerOptions>` instead of a `custom-defined` object.
+
+## [4.8.3] - 2025-02-06
+
+### Fixed
+
+- `off()` behavior, sync with socket-io-client and takes a single function, not array
+- Mark internal fields as private in `WrappedSocket`.
+
+### Removed
+
+- Outdated `@types/socket-io` & `@types/socket.io-client` dependencies and use the built-in types instead.
+
+## [4.8.2] - 2024-12-27
+
+### Added
+
+- Return types to help users.
+- emitWithAck().
+- offAny().
+- offAnyOutgoing().
+- send().
+- compress().
+- export SOCKET_CONFIG_TOKEN.
+
+### Fixed
+
+- socket.of() method.
+- Chaining methods.
+- Volatile usage.
+- connect() and disconnect() arguments.
+
+## [4.8.1] - 2024-11-25
+
+### Update
+
+- Bump `@angular/core` dependencies to v19.0.0.
+
+## [4.8.0] - 2024-11-21
+
+### Update
+
+- Bump `@angular` dependencies to v19.0.0.
+
+## [4.7.0] - 2024-05-24
+
+### Update
+
+- Bump `@angular` dependencies to v18.0.0.
+- Bump `ng-packagr` dependencies to v18.0.0.
+- Bump `typescript` dependencies to v5.4.0.
+
 ## [4.6.1] - 2023-11-09
 
 ### Fixed

README.md

@@ -22,11 +22,13 @@ Make sure you're using the proper corresponding version of socket.io on the serv
 | v4.3.0          | v4.5.1                   | 14.x            |
 | v4.4.0          | v4.5.1                   | 15.x            |
 | v4.5.0          | v4.5.1                   | 16.x            |
-| v4.6.0          | v4.7.2                   | 17.x            |
+| v4.6.1          | v4.7.2                   | 17.x            |
+| v4.7.0          | v4.7.2                   | 18.x            |
+| v4.8.1          | v4.8.1                   | 19.x            |
 
 ## How to use
 
-### Import and configure SocketIoModule
+### Import and configure SocketIoModule for NgModule based applications
 
 ```ts
 import { SocketIoModule, SocketIoConfig } from 'ngx-socket-io';
@@ -46,6 +48,23 @@ We need to configure `SocketIoModule` module using the object `config` of type `
 
 Now we pass the configuration to the static method `forRoot` of `SocketIoModule`
 
+### Import and configure SocketIoModule for standalone based applications
+
+In app.config.ts use the following:
+
+```ts
+import { ApplicationConfig, importProvidersFrom } from '@angular/core';
+import { SocketIoModule, SocketIoConfig } from 'ngx-socket-io';
+
+const config: SocketIoConfig = { url: 'http://localhost:8988', options: {} };
+
+export const appConfig: ApplicationConfig = {
+  providers: [importProvidersFrom(SocketIoModule.forRoot(config))],
+};
+```
+
+For standalone applications we do not have the AppModule where we can import the `SocketIoModule`. Instead we can use the `importProvidersFrom` provided by angular to provide the `SocketIoModule` to our application. The usage of the socket instance is then the same as if we used a NgModule based application.
+
 ### Using your socket Instance
 
 The `SocketIoModule` provides now a configured `Socket` service that can be injected anywhere inside the `AppModule`.
@@ -116,8 +135,10 @@ The only addition is the `fromEvent` method, which returns an `Observable` that
 
 ### `socket.of(namespace: string)`
 
-Takes an namespace.
-Works the same as in Socket.IO.
+Takes a namespace and returns an instance based on the current config and the given namespace,
+that is added to the end of the current url.
+See [Namespaces - Client Initialization](https://socket.io/docs/v4/namespaces/#client-initialization).
+Instances are reused based on the namespace.
 
 ### `socket.on(eventName: string, callback: Function)`
 

index.ts

@@ -1,3 +1,3 @@
-export { SocketIoModule }    from './src/socket-io.module';
+export { SocketIoModule, SOCKET_CONFIG_TOKEN } from './src/socket-io.module';
 export { SocketIoConfig } from './src/config/socket-io.config';
 export { WrappedSocket as Socket }   from './src/socket-io.service';