feat: add isStruct method

kgryte · kgryte · commit bf26784b458d · 2025-06-23T18:24:00.000-07:00
This static method is similar to `Buffer.isBuffer` in Node.js.

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/dstructs/struct/lib/main.js b/lib/node_modules/@stdlib/dstructs/struct/lib/main.js
@@ -24,6 +24,7 @@
 
 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
 var setNonEnumerableReadOnlyAccessor = require( '@stdlib/utils/define-nonenumerable-read-only-accessor' );
+var isStructConstructorLike = require( '@stdlib/assert/is-struct-constructor-like' );
 var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
 var isCollection = require( '@stdlib/assert/is-collection' );
 var isArrayBuffer = require( '@stdlib/assert/is-arraybuffer' );
@@ -422,6 +423,27 @@ function factory( fields ) {
 		return obj[ PRIVATE_BUFFER ].buffer;
 	});
 
+	/**
+	* Returns a boolean indicating whether a provided value is a `struct` instance.
+	*
+	* @private
+	* @name isStruct
+	* @memberof Struct
+	* @readonly
+	* @type {Function}
+	* @param {*} value - input value
+	* @returns {boolean} boolean indicating whether a value is a `struct` instance
+	*/
+	setReadOnly( Struct, 'isStruct', function isStruct( value ) {
+		return (
+			value instanceof Struct ||
+			(
+				isStructInstance( value ) &&
+				isStructConstructorLike( value.constructor )
+			)
+		);
+	});
+
 	/**
 	* Returns the underlying byte buffer of a `struct` as a `DataView`.
 	*
