Documentation/client/add documentation

[FreePhoenix888]

Resolves #301

[FreePhoenix888]

What documentation would you add to can?

deeplinks/imports/client.tsx

Lines 1515 to 1531 in dcdee14

	/**
	* Checks whether {@link subjectUds} can perform {@link actionIds} on {@link objectIds}
	* @param objectIds A link id or an array of link ids to check whether the {@link subjectUds} can perform the {@link actionIds} on
	* @param subjectIds A link id or an array of link ids to check whether they can perform the {@link actionIds} on the {@link objectIds}
	* @param actionIds A link id or an array of link ids to check whether the {@link subjectUds} can perform on the {@link objectIds}
	* @param userIds A link id or an array of link ids from which perspective the check is performed
	* @returns A promise that resolves to a boolean value indicating whether the {@link subjectUds} can perform the {@link actionIds} on the {@link objectIds}
	*/
	async can(objectIds: null | number | number[], subjectIds: null | number | number[], actionIds: null | number | number[], userIds: number | number[] = this.linkId) {
	const where: any = {
	};
	if (objectIds) where.object_id = typeof(objectIds) === 'number' ? { _eq: +objectIds } : { _in: objectIds };
	if (subjectIds) where.subject_id = typeof(subjectIds) === 'number' ? { _eq: +subjectIds } : { _in: subjectIds };
	if (actionIds) where.action_id = typeof(actionIds) === 'number' ? { _eq: +actionIds } : { _in: actionIds };
	const result = await this.select(where, { table: 'can', returning: 'rule_id' });
	return !!result?.data?.length;
	}

@konard