Skip to content

chore: update JSDOC type to support plug agent #1827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
krpeacock merged 8 commits into from
Oct 10, 2022
Merged

chore: update JSDOC type to support plug agent #1827

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fbb709f
chore: update JSDOC type to support plug agent
krpeacock Sep 20, 2021
aef940e
amended
krpeacock Sep 20, 2021
f630dd8
canister_name
krpeacock Sep 21, 2021
b809199
Merge branch 'master' into SDK-127-allow-agent-to-be-passed-to-dfx-js…
krpeacock Sep 27, 2021
dd519b7
Merge branch 'master' into SDK-127-allow-agent-to-be-passed-to-dfx-js…
krpeacock Oct 10, 2022
3f9b0d8
updates for consistency
krpeacock Oct 10, 2022
0d4c197
moving types to .d.ts file
krpeacock Oct 10, 2022
45a8a5b
formatting + IDL
krpeacock Oct 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/dfx/assets/language_bindings/canister.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ export { idlFactory } from './{canister_name}.did.js';
export const canisterId = process.env.{canister_name_uppercase}_CANISTER_ID;

/**
*
*
* @param {string | import("@dfinity/principal").Principal} canisterId Canister ID of Agent
* @param {{agentOptions?: import("@dfinity/agent").HttpAgentOptions; actorOptions?: import("@dfinity/agent").ActorConfig}} [options]
* @return {import("@dfinity/agent").ActorSubclass<import("./{canister_name}.did.js")._SERVICE>}
* @param {{agentOptions?: import("@dfinity/agent").HttpAgentOptions; actorOptions?: import("@dfinity/agent").ActorConfig} | { agent?: import("@dfinity/agent").Agent; actorOptions?: import("@dfinity/agent").ActorConfig }} [options]
* @return {import("@dfinity/agent").ActorSubclass<import("./canvas_backend.did.js")._SERVICE>}
Comment thread
krpeacock marked this conversation as resolved.
Outdated
*/
export const createActor = (canisterId, options) => {
const agent = new HttpAgent({ ...options?.agentOptions });
const agent = options.agent || new HttpAgent({ ...options?.agentOptions });

// Fetch root key for certificate validation during development
if(process.env.NODE_ENV !== "production") {
Expand Down