@warp-drive/legacy 5.9.0-alpha.9 → 5.9.0-beta.1

package/declarations/adapter/-private/build-url-mixin.d.ts

@@ -1,33 +1,189 @@
 import Mixin from "@ember/object/mixin";
 import type { Snapshot, SnapshotRecordArray } from "../../compat/-private.js";
+/**
+* The methods provided by the `BuildURLMixin` mixin (see the exported
+* `BuildURLMixin` {@link Mixin} below).
+*
+* See also {@link MixtBuildURLMixin}, the interface used to type `this`
+* within these methods.
+*/
 export interface BuildURLMixin {
+	/**
+	* Builds a URL for a given type and optional ID.
+	*
+	* By default, it pluralizes the type's name (for example, 'post'
+	* becomes 'posts' and 'person' becomes 'people'). To override the
+	* pluralization see {@link BuildURLMixin.pathForType | pathForType}.
+	*
+	* If an ID is specified, it adds the ID to the path generated
+	* for the type, separated by a `/`.
+	*
+	* This overload builds the URL for a `store.findRecord(type, id)` call.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: string, snapshot: Snapshot, requestType: "findRecord"): string;
+	/**
+	* Builds the URL for a `store.findAll(type)` call.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: null, snapshot: SnapshotRecordArray, requestType: "findAll"): string;
+	/**
+	* Builds the URL for a `store.query(type, query)` call.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: null, snapshot: null, requestType: "query", query: Record<string, unknown>): string;
+	/**
+	* Builds the URL for a `store.queryRecord(type, query)` call.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: null, snapshot: null, requestType: "queryRecord", query: Record<string, unknown>): string;
+	/**
+	* Builds the URL for coalescing multiple `store.findRecord(type, id)`
+	* records into 1 request when the adapter's `coalesceFindRequests`
+	* property is `true`. The `id` and `snapshot` parameters will be
+	* arrays of ids and snapshots.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: string[], snapshot: Snapshot[], requestType: "findMany"): string;
+	/**
+	* Builds the URL for fetching an async `hasMany` relationship when a
+	* URL is not provided by the server.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: string, snapshot: Snapshot, requestType: "findHasMany"): string;
+	/**
+	* Builds the URL for fetching an async `belongsTo` relationship when a
+	* URL is not provided by the server.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: string, snapshot: Snapshot, requestType: "findBelongsTo"): string;
+	/**
+	* Builds the URL for a `record.save()` call when the record was
+	* created locally using `store.createRecord()`.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: string | null, snapshot: Snapshot, requestType: "createRecord"): string;
+	/**
+	* Builds the URL for a `record.save()` call when the record has been
+	* updated locally.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: string, snapshot: Snapshot, requestType: "updateRecord"): string;
+	/**
+	* Builds the URL for a `record.save()` call when the record has been
+	* deleted locally.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: string, snapshot: Snapshot, requestType: "deleteRecord"): string;
+	/**
+	* Builds a URL for a given type and ID without a specific request type.
+	*
+	* @public
+	*/
 	buildURL(this: MixtBuildURLMixin, modelName: string, id: string, snapshot: Snapshot): string;
+	/**
+	* @private
+	*/
 	_buildURL(this: MixtBuildURLMixin, modelName: string | null | undefined, id?: string | null): string;
+	/**
+	* Builds a URL for a `store.findRecord(type, id)` call.
+	*
+	* @public
+	*/
 	urlForFindRecord(this: MixtBuildURLMixin, id: string, modelName: string, snapshot: Snapshot): string;
+	/**
+	* Builds a URL for a `store.findAll(type)` call.
+	*
+	* @public
+	*/
 	urlForFindAll(this: MixtBuildURLMixin, modelName: string, snapshots: SnapshotRecordArray): string;
+	/**
+	* Builds a URL for a `store.queryRecord(type, query)` call.
+	*
+	* @public
+	*/
 	urlForQueryRecord(this: MixtBuildURLMixin, query: Record<string, unknown>, modelName: string): string;
+	/**
+	* Builds a URL for a `store.query(type, query)` call.
+	*
+	* @public
+	*/
 	urlForQuery(this: MixtBuildURLMixin, query: Record<string, unknown>, modelName: string): string;
+	/**
+	* Builds a URL for coalescing multiple `store.findRecord(type, id)`
+	* records into 1 request when the adapter's `coalesceFindRequests`
+	* property is `true`.
+	*
+	* @public
+	*/
 	urlForFindMany(this: MixtBuildURLMixin, ids: string[], modelName: string, snapshots: Snapshot[]): string;
+	/**
+	* Builds a URL for fetching an async `hasMany` relationship when a
+	* URL is not provided by the server.
+	*
+	* @public
+	*/
 	urlForFindHasMany(this: MixtBuildURLMixin, id: string, modelName: string, snapshot: Snapshot): string;
+	/**
+	* Builds a URL for fetching an async `belongsTo` relationship when a
+	* URL is not provided by the server.
+	*
+	* @public
+	*/
 	urlForFindBelongsTo(this: MixtBuildURLMixin, id: string, modelName: string, snapshot: Snapshot): string;
+	/**
+	* Builds a URL for a `record.save()` call when the record was created
+	* locally using `store.createRecord()`.
+	*
+	* @public
+	*/
 	urlForCreateRecord(this: MixtBuildURLMixin, modelName: string, snapshot: Snapshot): string;
+	/**
+	* Builds a URL for a `record.save()` call when the record has been
+	* updated locally.
+	*
+	* @public
+	*/
 	urlForUpdateRecord(this: MixtBuildURLMixin, id: string, modelName: string, snapshot: Snapshot): string;
+	/**
+	* Builds a URL for a `record.save()` call when the record has been
+	* deleted locally.
+	*
+	* @public
+	*/
 	urlForDeleteRecord(this: MixtBuildURLMixin, id: string, modelName: string, snapshot: Snapshot): string;
+	/**
+	* @private
+	*/
 	urlPrefix(this: MixtBuildURLMixin, path?: string | null, parentURL?: string): string;
+	/**
+	* Determines the pathname for a given type.
+	*
+	* By default, it pluralizes the type's name (for example, 'post'
+	* becomes 'posts' and 'person' becomes 'people').
+	*
+	* @public
+	*/
 	pathForType(this: MixtBuildURLMixin, modelName: string): string;
 }
 export interface MixtBuildURLMixin extends BuildURLMixin {
 	host: string | null;
 	namespace: string | null;
 }
+/**
+* The `Mixin` implementation of {@link BuildURLMixin}, ready to be applied
+* to an `EmberObject` subclass such as an `Adapter`.
+*
+* @public
+*/
 export declare const BuildURLMixin: Mixin;