chore: fix @returns => @return in jsdoc

Author: runspired

config/eslint/browser.js

@@ -41,7 +41,7 @@ export function rules(config = {}) {
   );
 }
 
-/** @returns {import('eslint').Linter.FlatConfig} */
+/** @return {import('eslint').Linter.FlatConfig} */
 export function browser(config = {}) {
   config.files = Array.isArray(config.files) ? config.files : ['**/*.{js,gjs}'];
   const base = ts.browser(config);

config/eslint/diagnostic.js

@@ -3,7 +3,7 @@ import * as qunit from './qunit.js';
 
 const QUNIT_BANNED_IMPORTS = ['ember-qunit', 'qunit', 'ember-exam'];
 
-/** @returns {import('eslint').Linter.FlatConfig} */
+/** @return {import('eslint').Linter.FlatConfig} */
 export function browser(config = {}) {
   const base = qunit.ember(config);
   base.rules = Object.assign(

config/eslint/node.js

@@ -2,7 +2,7 @@
 import nodePlugin from 'eslint-plugin-n';
 import globals from 'globals';
 
-/** @returns {import('eslint').Linter.FlatConfig} */
+/** @return {import('eslint').Linter.FlatConfig} */
 export function cjs(config) {
   const result = {
     files: [
@@ -62,7 +62,7 @@ export function cjs(config) {
   return finalConfig;
 }
 
-/** @returns {import('eslint').Linter.FlatConfig} */
+/** @return {import('eslint').Linter.FlatConfig} */
 export function esm(config) {
   const result = {
     files: [

config/eslint/qunit.js

@@ -24,7 +24,7 @@ export function plugins() {
   return { qunit: lintQUnit };
 }
 
-/** @returns {import('eslint').Linter.FlatConfig} */
+/** @return {import('eslint').Linter.FlatConfig} */
 export function ember(config = {}) {
   config.allowedImports = Array.isArray(config.allowedImports)
     ? config.allowedImports.concat(QUNIT_IMPORTS)
@@ -41,7 +41,7 @@ export function ember(config = {}) {
   };
 }
 
-/** @returns {import('eslint').Linter.FlatConfig} */
+/** @return {import('eslint').Linter.FlatConfig} */
 export function node(config = {}) {
   config.allowedImports = Array.isArray(config.allowedImports) ? config.allowedImports.concat(['qunit']) : ['qunit'];
 

config/eslint/typescript.js

@@ -6,7 +6,7 @@ import globals from 'globals';
 import noop from 'ember-eslint-parser/noop';
 import emberEslintParser from 'ember-eslint-parser';
 
-/** @returns {import('eslint').Linter.FlatConfig} */
+/** @return {import('eslint').Linter.FlatConfig} */
 function mergeTsConfigs(configArray) {
   const merged = {
     languageOptions: {},
@@ -122,7 +122,7 @@ export function constructFileGlobs(srcDirs, files) {
   return globs;
 }
 
-/** @returns {import('eslint').Linter.FlatConfig} */
+/** @return {import('eslint').Linter.FlatConfig} */
 export function browser(config) {
   config.files = config.files ?? ['**/*.ts'];
   /** @type {string[]} */
@@ -170,7 +170,7 @@ export function browser(config) {
   return lintconfig;
 }
 
-/** @returns {import('eslint').Linter.FlatConfig} */
+/** @return {import('eslint').Linter.FlatConfig} */
 export function node(config) {
   config.files = config.files ?? ['**/*.ts'];
   /** @type {string[]} */

packages/diagnostic/src/-ember/is-component.ts

@@ -10,7 +10,7 @@ export type ComponentLike = object;
  * (see https://github.com/emberjs/rfcs/pull/785 for more info).
  * @private
  * @param {Object} maybeComponent The thing you think might be a component
- * @returns {boolean} True if it's a component, false if not
+ * @return {boolean} True if it's a component, false if not
  */
 function isComponent(maybeComponent: object): maybeComponent is ComponentLike {
   return !!(getComponentManager as (c: object, v: boolean) => object)(maybeComponent, true);

packages/eslint-plugin-warp-drive/src/rules/no-create-record-rerender.js

@@ -144,7 +144,7 @@ function getParentFunction(/** @type {import('eslint').Rule.Node} */ node) {
 /**
  *
  * @param {import('eslint').Rule.Node} maybeParentFunction
- * @returns {boolean}
+ * @return {boolean}
  */
 function parentFunctionIsConstructor(maybeParentFunction) {
   return 'kind' in maybeParentFunction.parent && maybeParentFunction.parent.kind === 'constructor';
@@ -153,7 +153,7 @@ function parentFunctionIsConstructor(maybeParentFunction) {
 /**
  *
  * @param {import('eslint').Rule.Node} maybeParentFunction
- * @returns {boolean}
+ * @return {boolean}
  */
 function parentFunctionIsInit(maybeParentFunction) {
   return (

packages/experiments/src/persisted-cache/cache.ts

@@ -52,7 +52,7 @@ export class PersistedCache implements Cache {
    *
    * @method put
    * @param {StructuredDocument} doc
-   * @returns {ResourceDocument}
+   * @return {ResourceDocument}
    * @internal
    */
   put<T>(doc: StructuredDocument<T> | { content: T }): ResourceDocument {
@@ -96,7 +96,7 @@ export class PersistedCache implements Cache {
    * @method patch
    * @internal
    * @param op the operation to perform
-   * @returns {void}
+   * @return {void}
    */
   patch(op: Operation): void {
     this._cache.patch(op);
@@ -144,7 +144,7 @@ export class PersistedCache implements Cache {
    * @method peek
    * @internal
    * @param {StableRecordIdentifier | StableDocumentIdentifier} identifier
-   * @returns {ResourceDocument | ResourceBlob | null} the known resource data
+   * @return {ResourceDocument | ResourceBlob | null} the known resource data
    */
   peek<T = unknown>(identifier: StableRecordIdentifier<TypeFromInstanceOrString<T>>): T | null;
   peek(identifier: StableDocumentIdentifier): ResourceDocument | null;
@@ -158,7 +158,7 @@ export class PersistedCache implements Cache {
    *
    * @method peekRequest
    * @param {StableDocumentIdentifier}
-   * @returns {StableDocumentIdentifier | null}
+   * @return {StableDocumentIdentifier | null}
    * @internal
    */
   peekRequest(identifier: StableDocumentIdentifier): StructuredDocument<ResourceDocument> | null {
@@ -173,7 +173,7 @@ export class PersistedCache implements Cache {
    * @param identifier
    * @param data
    * @param hasRecord
-   * @returns {void | string[]} if `hasRecord` is true then calculated key changes should be returned
+   * @return {void | string[]} if `hasRecord` is true then calculated key changes should be returned
    */
   upsert(identifier: StableRecordIdentifier, data: ResourceBlob, hasRecord: boolean): void | string[] {
     return this._cache.upsert(identifier, data, hasRecord);
@@ -191,7 +191,7 @@ export class PersistedCache implements Cache {
    *
    * @method fork
    * @internal
-   * @returns Promise<Cache>
+   * @return Promise<Cache>
    */
   fork(): Promise<Cache> {
     return this._cache.fork();
@@ -207,7 +207,7 @@ export class PersistedCache implements Cache {
    * @method merge
    * @param {Cache} cache
    * @internal
-   * @returns Promise<void>
+   * @return Promise<void>
    */
   merge(cache: Cache): Promise<void> {
     return this._cache.merge(cache);
@@ -259,7 +259,7 @@ export class PersistedCache implements Cache {
    * via `cache.hydrate`.
    *
    * @method dump
-   * @returns {Promise<ReadableStream>}
+   * @return {Promise<ReadableStream>}
    * @internal
    */
   dump(): Promise<ReadableStream<unknown>> {
@@ -280,7 +280,7 @@ export class PersistedCache implements Cache {
    *
    * @method hydrate
    * @param {ReadableStream} stream
-   * @returns {Promise<void>}
+   * @return {Promise<void>}
    * @internal
    */
   hydrate(stream: ReadableStream<unknown>): Promise<void> {
@@ -368,7 +368,7 @@ export class PersistedCache implements Cache {
    * @internal
    * @param identifier
    * @param propertyName
-   * @returns {unknown}
+   * @return {unknown}
    */
   getAttr(identifier: StableRecordIdentifier, field: string): Value | undefined {
     return this._cache.getAttr(identifier, field);
@@ -405,7 +405,7 @@ export class PersistedCache implements Cache {
    * @method hasChangedAttrs
    * @internal
    * @param identifier
-   * @returns {boolean}
+   * @return {boolean}
    */
   hasChangedAttrs(identifier: StableRecordIdentifier): boolean {
     return this._cache.hasChangedAttrs(identifier);
@@ -417,7 +417,7 @@ export class PersistedCache implements Cache {
    * @method rollbackAttrs
    * @internal
    * @param identifier
-   * @returns the names of attributes that were restored
+   * @return the names of attributes that were restored
    */
   rollbackAttrs(identifier: StableRecordIdentifier): string[] {
     return this._cache.rollbackAttrs(identifier);
@@ -492,7 +492,7 @@ export class PersistedCache implements Cache {
    * @internal
    * @param identifier
    * @param propertyName
-   * @returns resource relationship object
+   * @return resource relationship object
    */
   getRelationship(
     identifier: StableRecordIdentifier,
@@ -536,7 +536,7 @@ export class PersistedCache implements Cache {
    * @method isEmpty
    * @internal
    * @param identifier
-   * @returns {boolean}
+   * @return {boolean}
    */
   isEmpty(identifier: StableRecordIdentifier): boolean {
     return this._cache.isEmpty(identifier);
@@ -549,7 +549,7 @@ export class PersistedCache implements Cache {
    * @method isNew
    * @internal
    * @param identifier
-   * @returns {boolean}
+   * @return {boolean}
    */
   isNew(identifier: StableRecordIdentifier): boolean {
     return this._cache.isNew(identifier);
@@ -562,7 +562,7 @@ export class PersistedCache implements Cache {
    * @method isDeleted
    * @internal
    * @param identifier
-   * @returns {boolean}
+   * @return {boolean}
    */
   isDeleted(identifier: StableRecordIdentifier): boolean {
     return this._cache.isDeleted(identifier);
@@ -575,7 +575,7 @@ export class PersistedCache implements Cache {
    * @method isDeletionCommitted
    * @internal
    * @param identifier
-   * @returns {boolean}
+   * @return {boolean}
    */
   isDeletionCommitted(identifier: StableRecordIdentifier): boolean {
     return this._cache.isDeletionCommitted(identifier);

packages/json-api/src/-private/cache.ts

@@ -1303,7 +1303,7 @@ export default class JSONAPICache implements Cache {
    * @method hasChangedAttrs
    * @public
    * @param identifier
-   * @returns {boolean}
+   * @return {boolean}
    */
   hasChangedAttrs(identifier: StableRecordIdentifier): boolean {
     const cached = this.__peek(identifier, true);

packages/store/src/-private/record-arrays/native-proxy-type-fix.ts

@@ -25,7 +25,7 @@ interface ProxyHandler<T extends object> {
   /**
    * A trap for `Object.defineProperty()`.
    * @param target The original object which is being proxied.
-   * @returns A `Boolean` indicating whether or not the property has been defined.
+   * @return A `Boolean` indicating whether or not the property has been defined.
    * @internal
    */
   defineProperty?(target: T, property: string | symbol, attributes: PropertyDescriptor): boolean;
@@ -34,7 +34,7 @@ interface ProxyHandler<T extends object> {
    * A trap for the `delete` operator.
    * @param target The original object which is being proxied.
    * @param p The name or `Symbol` of the property to delete.
-   * @returns A `Boolean` indicating whether or not the property was deleted.
+   * @return A `Boolean` indicating whether or not the property was deleted.
    * @internal
    */
   deleteProperty?(target: T, p: string | symbol): boolean;
@@ -97,7 +97,7 @@ interface ProxyHandler<T extends object> {
    * @param target The original object which is being proxied.
    * @param p The name or `Symbol` of the property to set.
    * @param receiver The object to which the assignment was originally directed.
-   * @returns A `Boolean` indicating whether or not the property was set.
+   * @return A `Boolean` indicating whether or not the property was set.
    * @internal
    */
   set?(target: T, p: string | symbol, newValue: any, receiver: any): boolean;

packages/store/src/-types/q/schema-service.ts

@@ -137,7 +137,7 @@ export interface SchemaService {
    * @method transformation
    * @public
    * @param {TransformableField|{ type: string }} field
-   * @returns {Transformation}
+   * @return {Transformation}
    */
   transformation(field: GenericField | ObjectField | ArrayField | { type: string }): Transformation;
 
@@ -148,7 +148,7 @@ export interface SchemaService {
    * @method hashFn
    * @public
    * @param {HashField|{ type: string }} field
-   * @returns {HashFn}
+   * @return {HashFn}
    */
   hashFn(field: HashField | { type: string }): HashFn;
 
@@ -159,7 +159,7 @@ export interface SchemaService {
    * @method derivation
    * @public
    * @param {DerivedField|{ type: string }} field
-   * @returns {Derivation}
+   * @return {Derivation}
    */
   derivation(field: DerivedField | { type: string }): Derivation;