@brightspace-hmc/siren-sdk
Advanced tools
@brightspace-hmc/siren-sdk - npm Package Compare versions
Comparing version 3.11.1 to 3.11.2
| { | ||
| "name": "@brightspace-hmc/siren-sdk", | ||
| "version": "3.11.1", | ||
| "version": "3.11.2", | ||
| "type": "module", | ||
@@ -5,0 +5,0 @@ "description": "", |
@@ -6,3 +6,3 @@ import { dispose, entityFactory, updateEntity } from './EntityFactory.js'; | ||
| * @typedef {import('siren-parser').Entity} ParsedEntity | ||
| * @typedef {import('./EntityFactory').EntityListener} EntityListener | ||
| * @typedef {import('./EntityFactory.js').EntityListener} EntityListener | ||
| */ | ||
@@ -18,3 +18,3 @@ | ||
| * @param {String|Function} [token] JWT Token for brightspace | a function that returns a JWT token for brightspace | null (defaults to cookie authentication in a browser) | ||
| * @param {EntityListener} listener Listener helper class | ||
| * @param {EntityListener} [listener] Listener helper class | ||
| */ | ||
@@ -21,0 +21,0 @@ constructor(entity, token, listener) { |
@@ -6,3 +6,3 @@ import 'd2l-polymer-siren-behaviors/store/entity-store.js'; | ||
| * @typedef {import('siren-parser').Link} SirenLink | ||
| * @typedef {import('./EntitySirenProperties').EntitySirenProperties} EntitySirenProperties | ||
| * @typedef {import('./EntitySirenProperties.js').EntitySirenProperties} EntitySirenProperties | ||
| */ | ||
@@ -67,7 +67,8 @@ | ||
| * This creates and fetch a new entity. Whenever the entity changes onChange is called. | ||
| * @param {new(...args: any[]) => EntitySirenProperties} entityType The type of the entity. For example OrganizationEntity | ||
| * @template {EntitySirenProperties} EntityType | ||
| * @param {new(...args: any[]) => EntityType} entityType The type of the entity. For example OrganizationEntity | ||
| * @param {SirenLink|String} href Siren Link or Href of the entity to be created | ||
| * @param {String|Function} [token] JWT Token for brightspace | a function that returns a JWT token for brightspace | null (defaults to cookie authentication in a browser) | ||
| * @param {(entity: EntitySirenProperties, error: any) => void} onChange Callback function that accepts an {entityType} to be called when entity changes. If there are errors onChange is called with (null, error) | ||
| * @param {ParsedEntity} entity (Optional) Entity that has already been fetched. | ||
| * @param {(entity: EntityType, error: any) => void} [onChange] Callback function that accepts an {entityType} to be called when entity changes. If there are errors onChange is called with (null, error) | ||
| * @param {ParsedEntity} [entity] (Optional) Entity that has already been fetched. | ||
| */ | ||
@@ -74,0 +75,0 @@ export function entityFactory(entityType, href, token, onChange, entity) { |
@@ -5,3 +5,3 @@ import { EntitySirenProperties } from './EntitySirenProperties.js'; | ||
| * @typedef {import('siren-parser').Entity} ParsedEntity | ||
| * @typedef {import('./Entity').Entity} SDKEntity | ||
| * @typedef {import('./Entity.js').Entity} SDKEntity | ||
| */ | ||
@@ -8,0 +8,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.01%
415295
- Lines of code
- increased by0.01%
11502