Refactor code structure and optimize performance across multiple modules
This commit is contained in:
@@ -1,4 +0,0 @@
|
||||
bb1da224c09031996224154611f2e1c2143c23b96ab583191766f7d281b20800 hashes.sha256
|
||||
421af53f9eeba6903098d292fbd56f98be62ea6130b5161859889bf11d699d18 sample-sbom-context.json
|
||||
e5aecfba5cee8d412408fb449f12fa4d5bf0a7cb7e5b316b99da3b9019897186 sample-vuln-output.ndjson
|
||||
736efd36508de7b72c9cbddf851335d9534c326af1670be7d101cbb91634357d sbom-context-response.json
|
||||
@@ -1,2 +0,0 @@
|
||||
421af53f9eeba6903098d292fbd56f98be62ea6130b5161859889bf11d699d18 out/console/guardrails/cli-vuln-29-001/sample-sbom-context.json
|
||||
e5aecfba5cee8d412408fb449f12fa4d5bf0a7cb7e5b316b99da3b9019897186 out/console/guardrails/cli-vuln-29-001/sample-vuln-output.ndjson
|
||||
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"schema": "stellaops.sbom.context/1.0",
|
||||
"input": "sbom.json",
|
||||
"generated": "2025-11-19T00:00:00Z",
|
||||
"packages": [
|
||||
{"name": "openssl", "version": "1.1.1w", "purl": "pkg:deb/openssl@1.1.1w"},
|
||||
{"name": "zlib", "version": "1.2.11", "purl": "pkg:deb/zlib@1.2.11"}
|
||||
]
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"command":"stella vuln scan","version":"0.1.0","tenant":"demo","input":"sbom.json","generated":"2025-11-19T00:00:00Z","summary":{"packages":3,"vulnerabilities":2},"vulnerabilities":[{"id":"CVE-2024-1234","package":"openssl","version":"1.1.1w","severity":"HIGH","source":"nvd","path":"/usr/lib/libssl.so"},{"id":"CVE-2024-2345","package":"zlib","version":"1.2.11","severity":"MEDIUM","source":"nvd","path":"/usr/lib/libz.so"}],"provenance":{"sbom_digest":"sha256:dummy-sbom","profile":"offline","evidence_bundle":"mirror-thin-m0-sample"}}
|
||||
@@ -1 +0,0 @@
|
||||
{"schema":"stellaops.sbom.context/1.0","generated":"2025-11-19T00:00:00Z","packages":[{"name":"openssl","version":"1.1.1w","purl":"pkg:deb/openssl@1.1.1w"},{"name":"zlib","version":"1.2.11","purl":"pkg:deb/zlib@1.2.11"}],"timeline":8,"dependencyPaths":5,"hash":"sha256:421af53f9eeba6903098d292fbd56f98be62ea6130b5161859889bf11d699d18"}
|
||||
@@ -1,4 +0,0 @@
|
||||
bb1da224c09031996224154611f2e1c2143c23b96ab583191766f7d281b20800 hashes.sha256
|
||||
421af53f9eeba6903098d292fbd56f98be62ea6130b5161859889bf11d699d18 sample-sbom-context.json
|
||||
e5aecfba5cee8d412408fb449f12fa4d5bf0a7cb7e5b316b99da3b9019897186 sample-vuln-output.ndjson
|
||||
1f8df765be98c193ac6fa52af778e2e0ec24a7c5acbdfe7a4a461d45bf98f573 sbom-context-response.json
|
||||
@@ -1,2 +0,0 @@
|
||||
421af53f9eeba6903098d292fbd56f98be62ea6130b5161859889bf11d699d18 out/console/guardrails/cli-vuln-29-001/sample-sbom-context.json
|
||||
e5aecfba5cee8d412408fb449f12fa4d5bf0a7cb7e5b316b99da3b9019897186 out/console/guardrails/cli-vuln-29-001/sample-vuln-output.ndjson
|
||||
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"schema": "stellaops.sbom.context/1.0",
|
||||
"input": "sbom.json",
|
||||
"generated": "2025-11-19T00:00:00Z",
|
||||
"packages": [
|
||||
{"name": "openssl", "version": "1.1.1w", "purl": "pkg:deb/openssl@1.1.1w"},
|
||||
{"name": "zlib", "version": "1.2.11", "purl": "pkg:deb/zlib@1.2.11"}
|
||||
]
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"command":"stella vuln scan","version":"0.1.0","tenant":"demo","input":"sbom.json","generated":"2025-11-19T00:00:00Z","summary":{"packages":3,"vulnerabilities":2},"vulnerabilities":[{"id":"CVE-2024-1234","package":"openssl","version":"1.1.1w","severity":"HIGH","source":"nvd","path":"/usr/lib/libssl.so"},{"id":"CVE-2024-2345","package":"zlib","version":"1.2.11","severity":"MEDIUM","source":"nvd","path":"/usr/lib/libz.so"}],"provenance":{"sbom_digest":"sha256:dummy-sbom","profile":"offline","evidence_bundle":"mirror-thin-m0-sample"}}
|
||||
@@ -1 +0,0 @@
|
||||
{"schema":"stellaops.sbom.context/1.0","generated":"2025-12-08T15:34:22.6874898+00:00","artifactId":"ghcr.io/stellaops/sample-api","purl":"pkg:npm/lodash@4.17.21","versions":[{"version":"2025.11.16.1","firstObserved":"2025-11-16T12:00:00+00:00","lastObserved":"2025-11-16T12:00:00+00:00","status":"observed","source":"scanner:surface_bundle_mock_v1.tgz","isFixAvailable":false,"metadata":{"provenance":"scanner:surface_bundle_mock_v1.tgz","digest":"sha256:112","source_bundle_hash":"sha256:bundle112"}},{"version":"2025.11.15.1","firstObserved":"2025-11-15T12:00:00+00:00","lastObserved":"2025-11-15T12:00:00+00:00","status":"observed","source":"scanner:surface_bundle_mock_v1.tgz","isFixAvailable":false,"metadata":{"provenance":"scanner:surface_bundle_mock_v1.tgz","digest":"sha256:111","source_bundle_hash":"sha256:bundle111"}}],"dependencyPaths":[{"nodes":[{"identifier":"sample-api","version":null},{"identifier":"rollup","version":null},{"identifier":"lodash","version":null}],"isRuntime":false,"source":"sbom.paths","metadata":{"environment":"prod","path_length":"3","artifact":"ghcr.io/stellaops/sample-api@sha256:111","nearest_safe_version":"pkg:npm/lodash@4.17.22","blast_radius":"low","scope":"build"}},{"nodes":[{"identifier":"sample-api","version":null},{"identifier":"express","version":null},{"identifier":"lodash","version":null}],"isRuntime":true,"source":"sbom.paths","metadata":{"environment":"prod","path_length":"3","artifact":"ghcr.io/stellaops/sample-api@sha256:111","nearest_safe_version":"pkg:npm/lodash@4.17.22","blast_radius":"medium","scope":"runtime"}}],"environmentFlags":{"prod":"2"},"blastRadius":{"impactedAssets":2,"impactedWorkloads":1,"impactedNamespaces":1,"impactedPercentage":0.5,"metadata":{"path_sample_count":"2","blast_radius_tags":"low,medium"}},"metadata":{"generated_at":"2025-12-08T15:34:22.6874898+00:00","artifact":"ghcr.io/stellaops/sample-api","version_count":"2","dependency_count":"2","source":"sbom-service","environment_flag_count":"1","blast_radius_present":"True"},"hash":"sha256:0c705259fdf984bf300baba0abf484fc3bbae977cf8a0a2d1877481f552d600d"}
|
||||
@@ -1,12 +0,0 @@
|
||||
{
|
||||
"generated_utc": "2025-11-18T21:41:23.244597Z",
|
||||
"summary": "Offline feed bundles registered here. Add entries when baking air-gap bundles.",
|
||||
"feeds": [
|
||||
{
|
||||
"name": "telemetry-offline-bundle",
|
||||
"path": "offline/feeds/telemetry-offline-bundle.tar.gz",
|
||||
"sha256": "49d3ac3502bad1caaed4c1f7bceaa4ce40fdfce6210d4ae20c90386aeb84ca4e",
|
||||
"description": "Telemetry offline bundle (migrated from out/telemetry)"
|
||||
}
|
||||
]
|
||||
}
|
||||
Binary file not shown.
@@ -1 +0,0 @@
|
||||
49d3ac3502bad1caaed4c1f7bceaa4ce40fdfce6210d4ae20c90386aeb84ca4e telemetry-offline-bundle.tar.gz
|
||||
@@ -1,14 +0,0 @@
|
||||
{
|
||||
"hash_algorithm": "blake3-256",
|
||||
"entries": [
|
||||
{ "path": "docs/notifications/schemas/notify-schemas-catalog.json", "digest": "34e8655b0c7ca70c844d4b9aee56bdd7bd30b6a8666d2af75a70856b16f5605d" },
|
||||
{ "path": "docs/notifications/schemas/notify-schemas-catalog.dsse.json", "digest": "7c537ff728312cefb0769568bd376adc2bd79f6926173bf21f50c873902133dc" },
|
||||
{ "path": "docs/notifications/gaps-nr1-nr10.md", "digest": "b889dfd19a9d0a0f7bafb958135fde151e63c1e5259453d592d6519ae1667819" },
|
||||
{ "path": "docs/notifications/fixtures/rendering/index.ndjson", "digest": "3a41e62687b6e04f50e86ea74706eeae28eef666d7c4dbb5dc2281e6829bf41a" },
|
||||
{ "path": "docs/notifications/fixtures/redaction/sample.json", "digest": "dd4eefc8dded5d6f46c832e959ba0eef95ee8b77f10ac0aae90f7c89ad42906c" },
|
||||
{ "path": "docs/notifications/operations/dashboards/notify-slo.json", "digest": "8b380cb5491727a3ec69d50789f5522ac66c97804bebbf7de326568e52b38fa9" },
|
||||
{ "path": "docs/notifications/operations/alerts/notify-slo-alerts.yaml", "digest": "2c3b702c42d3e860c7f4e51d577f77961e982e1d233ef5ec392cba5414a0056d" },
|
||||
{ "path": "offline/notifier/notify-kit.manifest.json", "digest": "15e0b2f670e6b8089c6c960e354f16ba8201d993a077a28794a30b8d1cb23e9a" },
|
||||
{ "path": "offline/notifier/notify-kit.manifest.dsse.json", "digest": "68742f4e5bd202afe2cc90964d51fea7971395f3e57a875ae7111dcbb760321e" }
|
||||
]
|
||||
}
|
||||
@@ -1,11 +0,0 @@
|
||||
{
|
||||
"payloadType": "application/vnd.notify.manifest+json",
|
||||
"payload": "ewogICJzY2hlbWFfdmVyc2lvbiI6ICJ2MS4wIiwKICAiZ2VuZXJhdGVkX2F0IjogIjIwMjUtMTItMDRUMDA6MDA6MDBaIiwKICAidGVuYW50X3Njb3BlIjogIioiLAogICJlbnZpcm9ubWVudCI6ICJvZmZsaW5lIiwKICAiYXJ0aWZhY3RzIjogWwogICAgeyAibmFtZSI6ICJzY2hlbWEtY2F0YWxvZyIsICJwYXRoIjogImRvY3Mvbm90aWZpY2F0aW9ucy9zY2hlbWFzL25vdGlmeS1zY2hlbWFzLWNhdGFsb2cuanNvbiIsICJkaWdlc3QiOiAiMzRlODY1NWIwYzdjYTcwYzg0NGQ0YjlhZWU1NmJkZDdiZDMwYjZhODY2NmQyYWY3NWE3MDg1NmIxNmY1NjA1ZCIgfSwKICAgIHsgIm5hbWUiOiAic2NoZW1hLWNhdGFsb2ctZHNzZSIsICJwYXRoIjogImRvY3Mvbm90aWZpY2F0aW9ucy9zY2hlbWFzL25vdGlmeS1zY2hlbWFzLWNhdGFsb2cuZHNzZS5qc29uIiwgImRpZ2VzdCI6ICI3YzUzN2ZmNzI4MzEyY2VmYjA3Njk1NjhiZDM3NmFkYzJiZDc5ZjY5MjYxNzNiZjIxZjUwYzg3MzkwMjEzM2RjIiB9LAogICAgeyAibmFtZSI6ICJydWxlcyIsICJwYXRoIjogImRvY3Mvbm90aWZpY2F0aW9ucy9nYXBzLW5yMS1ucjEwLm1kIiwgImRpZ2VzdCI6ICJiODg5ZGZkMTlhOWQwYTBmN2JhZmI5NTgxMzVmZGUxNTFlNjNjMWU1MjU5NDUzZDU5MmQ2NTE5YWUxNjY3ODE5IiB9LAogICAgeyAibmFtZSI6ICJmaXh0dXJlcy1yZW5kZXJpbmciLCAicGF0aCI6ICJkb2NzL25vdGlmaWNhdGlvbnMvZml4dHVyZXMvcmVuZGVyaW5nL2luZGV4Lm5kanNvbiIsICJkaWdlc3QiOiAiM2E0MWU2MjY4N2I2ZTA0ZjUwZTg2ZWE3NDcwNmVlYWUyOGVlZjY2NmQ3YzRkYmI1ZGMyMjgxZTY4MjliZjQxYSIgfSwKICAgIHsgIm5hbWUiOiAiZml4dHVyZXMtcmVkYWN0aW9uIiwgInBhdGgiOiAiZG9jcy9ub3RpZmljYXRpb25zL2ZpeHR1cmVzL3JlZGFjdGlvbi9zYW1wbGUuanNvbiIsICJkaWdlc3QiOiAiZGQ0ZWVmYzhkZGVkNWQ2ZjQ2YzgzMmU5NTliYTBlZWY5NWVlOGI3N2YxMGFjMGFhZTkwZjdjODlhZDQyOTA2YyIgfSwKICAgIHsgIm5hbWUiOiAiZGFzaGJvYXJkcyIsICJwYXRoIjogImRvY3Mvbm90aWZpY2F0aW9ucy9vcGVyYXRpb25zL2Rhc2hib2FyZHMvbm90aWZ5LXNsby5qc29uIiwgImRpZ2VzdCI6ICI4YjM4MGNiNTQ5MTcyN2EzZWM2OWQ1MDc4OWY1NTIyYWM2NmM5NzgwNGJlYmJmN2RlMzI2NTY4ZTUyYjM4ZmE5IiB9LAogICAgeyAibmFtZSI6ICJhbGVydHMiLCAicGF0aCI6ICJkb2NzL25vdGlmaWNhdGlvbnMvb3BlcmF0aW9ucy9hbGVydHMvbm90aWZ5LXNsby1hbGVydHMueWFtbCIsICJkaWdlc3QiOiAiMmMzYjcwMmM0MmQzZTg2MGM3ZjRlNTFkNTc3Zjc3OTYxZTk4MmUxZDIzM2VmNWVjMzkyY2JhNTQxNGEwMDU2ZCIgfQogIF0sCiAgImhhc2hfYWxnb3JpdGhtIjogImJsYWtlMy0yNTYiLAogICJjYW5vbmljYWxpemF0aW9uIjogImpzb24tbm9ybWFsaXplZC11dGY4Igp9Cg==",
|
||||
"signatures": [
|
||||
{
|
||||
"sig": "DZwohxh6AOAP7Qf9geoZjw2jTXVU3rR8sYw4mgKpMu0=",
|
||||
"keyid": "notify-dev-hmac-001",
|
||||
"signedAt": "2025-12-04T21:13:10+00:00"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,17 +0,0 @@
|
||||
{
|
||||
"schema_version": "v1.0",
|
||||
"generated_at": "2025-12-04T00:00:00Z",
|
||||
"tenant_scope": "*",
|
||||
"environment": "offline",
|
||||
"artifacts": [
|
||||
{ "name": "schema-catalog", "path": "docs/notifications/schemas/notify-schemas-catalog.json", "digest": "34e8655b0c7ca70c844d4b9aee56bdd7bd30b6a8666d2af75a70856b16f5605d" },
|
||||
{ "name": "schema-catalog-dsse", "path": "docs/notifications/schemas/notify-schemas-catalog.dsse.json", "digest": "7c537ff728312cefb0769568bd376adc2bd79f6926173bf21f50c873902133dc" },
|
||||
{ "name": "rules", "path": "docs/notifications/gaps-nr1-nr10.md", "digest": "b889dfd19a9d0a0f7bafb958135fde151e63c1e5259453d592d6519ae1667819" },
|
||||
{ "name": "fixtures-rendering", "path": "docs/notifications/fixtures/rendering/index.ndjson", "digest": "3a41e62687b6e04f50e86ea74706eeae28eef666d7c4dbb5dc2281e6829bf41a" },
|
||||
{ "name": "fixtures-redaction", "path": "docs/notifications/fixtures/redaction/sample.json", "digest": "dd4eefc8dded5d6f46c832e959ba0eef95ee8b77f10ac0aae90f7c89ad42906c" },
|
||||
{ "name": "dashboards", "path": "docs/notifications/operations/dashboards/notify-slo.json", "digest": "8b380cb5491727a3ec69d50789f5522ac66c97804bebbf7de326568e52b38fa9" },
|
||||
{ "name": "alerts", "path": "docs/notifications/operations/alerts/notify-slo-alerts.yaml", "digest": "2c3b702c42d3e860c7f4e51d577f77961e982e1d233ef5ec392cba5414a0056d" }
|
||||
],
|
||||
"hash_algorithm": "blake3-256",
|
||||
"canonicalization": "json-normalized-utf8"
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-attest-expiry-warning-email-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "email",
|
||||
"key": "tmpl-attest-expiry-warning",
|
||||
"locale": "en-us",
|
||||
"renderMode": "html",
|
||||
"format": "email",
|
||||
"description": "Expiry warning for attestations approaching their expiration window.",
|
||||
"body": "<h2>Attestation expiry notice</h2>\n<p>The attestation for <code>{{payload.subject.repository}}</code> (digest {{payload.subject.digest}}) expires on <strong>{{payload.attestation.expiresAt}}</strong>.</p>\n<ul>\n <li>Issued: {{payload.attestation.issuedAt}}</li>\n <li>Signer: <code>{{payload.signer.kid}}</code> ({{payload.signer.algorithm}})</li>\n <li>Time remaining: {{expires_in payload.attestation.expiresAt event.ts}}</li>\n</ul>\n<p>Please rotate the attestation before expiry using <a href=\"{{payload.links.docs}}\">these instructions</a>.</p>\n<p>Console: <a href=\"{{payload.links.console}}\">{{payload.links.console}}</a></p>\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-12"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-attest-expiry-warning-slack-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "slack",
|
||||
"key": "tmpl-attest-expiry-warning",
|
||||
"locale": "en-us",
|
||||
"renderMode": "markdown",
|
||||
"format": "slack",
|
||||
"description": "Slack reminder for attestations approaching their expiration window.",
|
||||
"body": ":warning: Attestation for `{{payload.subject.digest}}` expires {{expires_in payload.attestation.expiresAt event.ts}}\nRepo: `{{payload.subject.repository}}`{{#if payload.subject.tag}} ({{payload.subject.tag}}){{/if}}\nSigner: `{{fingerprint payload.signer.kid}}` ({{payload.signer.algorithm}})\nIssued: {{payload.attestation.issuedAt}} · Expires: {{payload.attestation.expiresAt}}\nRenewal steps: {{link \"Docs\" payload.links.docs}} · Console: {{link \"Open\" payload.links.console}}\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-16"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-attest-key-rotation-email-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "email",
|
||||
"key": "tmpl-attest-key-rotation",
|
||||
"locale": "en-us",
|
||||
"renderMode": "html",
|
||||
"format": "email",
|
||||
"description": "Email bulletin for attestation key rotation or revocation events.",
|
||||
"body": "<h2>Attestation key rotation notice</h2>\n<p>Authority rotated or revoked signing keys at {{payload.rotation.executedAt}}.</p>\n<ul>\n <li>Rotation batch: {{payload.rotation.batchId}}</li>\n <li>Impacted services: {{payload.rotation.impactedServices}}</li>\n <li>Reason: {{payload.rotation.reason}}</li>\n</ul>\n<p>Recommended action: {{payload.recommendation}}</p>\n<p>Docs: <a href=\"{{payload.links.docs}}\">Rotation playbook</a></p>\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-12"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-attest-key-rotation-webhook-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "webhook",
|
||||
"key": "tmpl-attest-key-rotation",
|
||||
"locale": "en-us",
|
||||
"renderMode": "json",
|
||||
"format": "webhook",
|
||||
"description": "Webhook payload for attestation key rotation/revocation events.",
|
||||
"body": "{\n \"event\": \"authority.keys.rotated\",\n \"tenantId\": \"{{event.tenant}}\",\n \"batchId\": \"{{payload.rotation.batchId}}\",\n \"executedAt\": \"{{payload.rotation.executedAt}}\",\n \"impactedServices\": \"{{payload.rotation.impactedServices}}\",\n \"reason\": \"{{payload.rotation.reason}}\",\n \"links\": {\n \"docs\": \"{{payload.links.docs}}\",\n \"console\": \"{{payload.links.console}}\"\n }\n}\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-12"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-attest-transparency-anomaly-slack-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "slack",
|
||||
"key": "tmpl-attest-transparency-anomaly",
|
||||
"locale": "en-us",
|
||||
"renderMode": "markdown",
|
||||
"format": "slack",
|
||||
"description": "Slack alert for transparency witness anomalies.",
|
||||
"body": ":warning: Transparency anomaly detected for `{{payload.subject.digest}}`\nWitness: `{{payload.transparency.witnessId}}` ({{payload.transparency.classification}})\nRekor index: {{payload.transparency.rekorIndex}}\nAnomaly window: {{payload.transparency.windowStart}} → {{payload.transparency.windowEnd}}\nRecommended action: {{payload.recommendation}}\nConsole details: {{link \"Open in Console\" payload.links.console}}\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-12"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-attest-transparency-anomaly-webhook-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "webhook",
|
||||
"key": "tmpl-attest-transparency-anomaly",
|
||||
"locale": "en-us",
|
||||
"renderMode": "json",
|
||||
"format": "webhook",
|
||||
"description": "Webhook payload for Rekor transparency anomalies.",
|
||||
"body": "{\n \"event\": \"attestor.transparency.anomaly\",\n \"tenantId\": \"{{event.tenant}}\",\n \"subjectDigest\": \"{{payload.subject.digest}}\",\n \"witnessId\": \"{{payload.transparency.witnessId}}\",\n \"classification\": \"{{payload.transparency.classification}}\",\n \"rekorIndex\": {{payload.transparency.rekorIndex}},\n \"window\": {\n \"start\": \"{{payload.transparency.windowStart}}\",\n \"end\": \"{{payload.transparency.windowEnd}}\"\n },\n \"links\": {\n \"console\": \"{{payload.links.console}}\",\n \"rekor\": \"{{payload.links.rekor}}\"\n },\n \"recommendation\": \"{{payload.recommendation}}\"\n}\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-12"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-attest-verify-fail-email-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "email",
|
||||
"key": "tmpl-attest-verify-fail",
|
||||
"locale": "en-us",
|
||||
"renderMode": "html",
|
||||
"format": "email",
|
||||
"description": "Email notice for attestation verification failures.",
|
||||
"body": "<h2>Attestation verification failure</h2>\n<p>The attestation for <code>{{payload.subject.repository}}</code> (digest {{payload.subject.digest}}) failed verification at {{event.ts}}.</p>\n<ul>\n <li>Reason: <code>{{payload.failure.reasonCode}}</code> — {{payload.failure.reason}}</li>\n <li>Signer: <code>{{payload.signer.kid}}</code> ({{payload.signer.algorithm}})</li>\n <li>Rekor entry: <a href=\"{{payload.links.rekor}}\">{{payload.links.rekor}}</a></li>\n <li>Last valid attestation: <a href=\"{{payload.links.console}}\">Console report</a></li>\n</ul>\n<p>{{payload.recommendation}}</p>\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-12"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-attest-verify-fail-slack-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "slack",
|
||||
"key": "tmpl-attest-verify-fail",
|
||||
"locale": "en-us",
|
||||
"renderMode": "markdown",
|
||||
"format": "slack",
|
||||
"description": "Slack alert for attestation verification failures with Rekor traceability.",
|
||||
"body": ":rotating_light: {{attestation_status_badge payload.failure.status}} verification failed for `{{payload.subject.digest}}`\nSigner: `{{fingerprint payload.signer.kid}}` ({{payload.signer.algorithm}})\nReason: `{{payload.failure.reasonCode}}` — {{payload.failure.reason}}\nLast valid attestation: {{link \"Console\" payload.links.console}}\nRekor entry: {{link \"Transparency log\" payload.links.rekor}}\nRecommended action: {{payload.recommendation}}\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-12"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-attest-verify-fail-webhook-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "webhook",
|
||||
"key": "tmpl-attest-verify-fail",
|
||||
"locale": "en-us",
|
||||
"renderMode": "json",
|
||||
"format": "webhook",
|
||||
"description": "JSON payload for Pager/SOC integrations on attestation verification failures.",
|
||||
"body": "{\n \"event\": \"attestor.verification.failed\",\n \"tenantId\": \"{{event.tenant}}\",\n \"subjectDigest\": \"{{payload.subject.digest}}\",\n \"repository\": \"{{payload.subject.repository}}\",\n \"reasonCode\": \"{{payload.failure.reasonCode}}\",\n \"reason\": \"{{payload.failure.reason}}\",\n \"signer\": {\n \"kid\": \"{{payload.signer.kid}}\",\n \"algorithm\": \"{{payload.signer.algorithm}}\"\n },\n \"rekor\": {\n \"url\": \"{{payload.links.rekor}}\",\n \"uuid\": \"{{payload.rekor.uuid}}\",\n \"index\": {{payload.rekor.index}}\n },\n \"recommendation\": \"{{payload.recommendation}}\"\n}\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-12"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-api-deprecation-email-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "email",
|
||||
"key": "tmpl-api-deprecation",
|
||||
"locale": "en-us",
|
||||
"renderMode": "html",
|
||||
"format": "email",
|
||||
"description": "Email notification for retiring Notifier API versions.",
|
||||
"body": "<h2>Notifier API deprecation notice</h2>\n<p>The Notifier API v1 endpoints are scheduled for sunset on <strong>{{metadata.sunset}}</strong>.</p>\n<ul>\n <li>Paths affected: {{metadata.paths}}</li>\n <li>Scope: notify.*</li>\n <li>Replacement: {{metadata.replacement}}</li>\n</ul>\n<p>Action: {{metadata.action}}</p>\n<p>Details: <a href=\"{{metadata.docs}}\">Deprecation bulletin</a></p>\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-17"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-api-deprecation-slack-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "slack",
|
||||
"key": "tmpl-api-deprecation",
|
||||
"locale": "en-us",
|
||||
"renderMode": "markdown",
|
||||
"format": "slack",
|
||||
"description": "Slack notice for retiring Notifier API versions.",
|
||||
"body": ":warning: Notifier API v1 is being deprecated.\nSunset: {{metadata.sunset}}\nPaths affected: {{metadata.paths}}\nDocs: {{link \"Deprecation details\" metadata.docs}}\nAction: {{metadata.action}}\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-17"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-risk-profile-state-email-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "email",
|
||||
"key": "tmpl-risk-profile-state",
|
||||
"locale": "en-us",
|
||||
"renderMode": "html",
|
||||
"format": "email",
|
||||
"description": "Email notice when risk profiles are published, deprecated, or thresholds change.",
|
||||
"body": "<h2>Risk profile update</h2>\n<p>Profile <strong>{{payload.profile.id}}</strong> is now <strong>{{payload.state}}</strong> (version {{payload.profile.version}}).</p>\n<ul>\n <li>Thresholds: {{payload.thresholds}}</li>\n <li>Owner: {{payload.owner}}</li>\n <li>Effective at: {{payload.effectiveAt}}</li>\n</ul>\n<p>Notes: {{payload.notes}}</p>\n<p>Console: <a href=\"{{payload.links.console}}\">View profile</a></p>\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-24"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-risk-profile-state-slack-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "slack",
|
||||
"key": "tmpl-risk-profile-state",
|
||||
"locale": "en-us",
|
||||
"renderMode": "markdown",
|
||||
"format": "json",
|
||||
"description": "Slack notice when risk profiles publish, deprecate, or thresholds change.",
|
||||
"body": "*Risk profile {{payload.profile.id}}* is now *{{payload.state}}* (v{{payload.profile.version}})\n• thresholds: {{payload.thresholds}}\n• owner: {{payload.owner}}\n• effective: {{payload.effectiveAt}}\n<{{payload.links.console}}|View profile>",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-24"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-risk-severity-change-email-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "email",
|
||||
"key": "tmpl-risk-severity-change",
|
||||
"locale": "en-us",
|
||||
"renderMode": "html",
|
||||
"format": "email",
|
||||
"description": "Email notice for risk severity escalation or downgrade.",
|
||||
"body": "<h2>Risk severity updated</h2>\n<p>Risk profile <strong>{{payload.profile.id}}</strong> changed severity from {{payload.previous.severity}} to {{payload.current.severity}} at {{event.ts}}.</p>\n<ul>\n <li>Asset: {{payload.asset.purl}}</li>\n <li>Profile version: {{payload.profile.version}}</li>\n <li>Reason: {{payload.reason}}</li>\n</ul>\n<p>View details: <a href=\"{{payload.links.console}}\">Console</a></p>\n",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-24"
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
{
|
||||
"schemaVersion": "notify.template@1",
|
||||
"templateId": "tmpl-risk-severity-change-slack-en-us",
|
||||
"tenantId": "bootstrap",
|
||||
"channelType": "slack",
|
||||
"key": "tmpl-risk-severity-change",
|
||||
"locale": "en-us",
|
||||
"renderMode": "markdown",
|
||||
"format": "json",
|
||||
"description": "Slack notice for risk severity escalation or downgrade.",
|
||||
"body": "*Risk severity changed* for {{payload.profile.id}}\n• from: {{payload.previous.severity}} → to: {{payload.current.severity}}\n• asset: {{payload.asset.purl}}\n• version: {{payload.profile.version}}\n• reason: {{payload.reason}}\n<{{payload.links.console}}|Open in console>",
|
||||
"metadata": {
|
||||
"author": "notifications-bootstrap",
|
||||
"version": "2025-11-24"
|
||||
}
|
||||
}
|
||||
@@ -1,56 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
ROOT=$(cd "$(dirname "$0")" && pwd)
|
||||
|
||||
missing=0
|
||||
for f in notify-kit.manifest.json notify-kit.manifest.dsse.json artifact-hashes.json; do
|
||||
if [ ! -f "$ROOT/$f" ]; then
|
||||
echo "[FAIL] missing $f" >&2
|
||||
missing=1
|
||||
fi
|
||||
done
|
||||
|
||||
if [ "$missing" -ne 0 ]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
python - <<'PY'
|
||||
import json, sys, pathlib, base64
|
||||
try:
|
||||
import blake3
|
||||
except ImportError:
|
||||
sys.stderr.write("blake3 module missing; install with `python -m pip install blake3`\n")
|
||||
sys.exit(1)
|
||||
|
||||
if '__file__' in globals() and __file__ not in (None, '<stdin>'):
|
||||
root = pathlib.Path(__file__).resolve().parent
|
||||
else:
|
||||
root = pathlib.Path.cwd()
|
||||
hashes = json.loads((root / "artifact-hashes.json").read_text())
|
||||
|
||||
def h(path: pathlib.Path):
|
||||
if path.suffix == ".json":
|
||||
data = json.dumps(json.loads(path.read_text()), sort_keys=True, separators=(',', ':')).encode()
|
||||
else:
|
||||
data = path.read_bytes()
|
||||
return blake3.blake3(data).hexdigest()
|
||||
|
||||
ok = True
|
||||
for entry in hashes["entries"]:
|
||||
path = root.parent.parent / entry["path"]
|
||||
digest = entry["digest"]
|
||||
if not path.exists():
|
||||
sys.stderr.write(f"[FAIL] missing file {path}\n")
|
||||
ok = False
|
||||
continue
|
||||
actual = h(path)
|
||||
if actual != digest:
|
||||
sys.stderr.write(f"[FAIL] digest mismatch {path}: expected {digest}, got {actual}\n")
|
||||
ok = False
|
||||
|
||||
if not ok:
|
||||
sys.exit(1)
|
||||
|
||||
print("[OK] All artifact hashes verified with blake3.")
|
||||
PY
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "Mp/3KeMPbvqDoEEI+qf4gwaq4+QO1uehmYodPvtVO+tb6AGhTjPF8f7PNG73BJ79p4EryWa/pAH4urrafl9+lQ==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/anglesharp/1.1.1/.signature.p7s
vendored
BIN
offline/packages/anglesharp/1.1.1/.signature.p7s
vendored
Binary file not shown.
@@ -1,40 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>AngleSharp</id>
|
||||
<version>1.1.1</version>
|
||||
<authors>AngleSharp</authors>
|
||||
<owners>Florian Rappl</owners>
|
||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>logo.png</icon>
|
||||
<readme>README.md</readme>
|
||||
<projectUrl>https://anglesharp.github.io/</projectUrl>
|
||||
<description>AngleSharp is the ultimate angle brackets parser library. It parses HTML5, CSS3, and XML to construct a DOM based on the official W3C specification.</description>
|
||||
<releaseNotes>https://github.com/AngleSharp/AngleSharp/blob/main/CHANGELOG.md</releaseNotes>
|
||||
<copyright>Copyright 2013-2024, AngleSharp.</copyright>
|
||||
<tags>html html5 css css3 xml dom dom4 parser engine hypertext markup language query selector attributes linq angle bracket web internet text headless browser</tags>
|
||||
<repository type="git" url="https://github.com/AngleSharp/AngleSharp" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="System.Text.Encoding.CodePages" version="7.0.0" />
|
||||
</group>
|
||||
<group targetFramework=".NETFramework4.6.1">
|
||||
<dependency id="System.Text.Encoding.CodePages" version="6.0.0" />
|
||||
</group>
|
||||
<group targetFramework=".NETFramework4.7.2">
|
||||
<dependency id="System.Text.Encoding.CodePages" version="6.0.0" />
|
||||
</group>
|
||||
<group targetFramework="net6.0">
|
||||
<dependency id="System.Text.Encoding.CodePages" version="6.0.0" />
|
||||
</group>
|
||||
<group targetFramework="net7.0">
|
||||
<dependency id="System.Text.Encoding.CodePages" version="7.0.0" />
|
||||
</group>
|
||||
<group targetFramework="net8.0">
|
||||
<dependency id="System.Text.Encoding.CodePages" version="8.0.0" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
162
offline/packages/anglesharp/1.1.1/README.md
vendored
162
offline/packages/anglesharp/1.1.1/README.md
vendored
@@ -1,162 +0,0 @@
|
||||

|
||||
|
||||
# AngleSharp
|
||||
|
||||
[](https://github.com/AngleSharp/AngleSharp/actions/workflows/ci.yml)
|
||||
[](https://github.com/AngleSharp/AngleSharp/releases)
|
||||
[](https://www.nuget.org/packages/AngleSharp/)
|
||||
[](https://github.com/AngleSharp/AngleSharp/issues)
|
||||
[](https://gitter.im/AngleSharp/AngleSharp)
|
||||
[](https://stackoverflow.com/tags/anglesharp)
|
||||
[](https://cla-assistant.io/AngleSharp/AngleSharp)
|
||||
|
||||
AngleSharp is a .NET library that gives you the ability to parse angle bracket based hyper-texts like HTML, SVG, and MathML. XML without validation is also supported by the library. An important aspect of AngleSharp is that CSS can also be parsed. The included parser is built upon the official W3C specification. This produces a perfectly portable HTML5 DOM representation of the given source code and ensures compatibility with results in evergreen browsers. Also standard DOM features such as `querySelector` or `querySelectorAll` work for tree traversal.
|
||||
|
||||
:zap::zap: **Migrating from AngleSharp 0.9 to AngleSharp 0.10 or later** (incl. 1.0)? Look at our [migration documentation](docs/tutorials/05-Migration.md). :zap::zap:
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Portable** (using .NET Standard 2.0)
|
||||
- **Standards conform** (works exactly as evergreen browsers)
|
||||
- **Great performance** (outperforms similar parsers in most scenarios)
|
||||
- **Extensible** (extend with your own services)
|
||||
- **Useful abstractions** (type helpers, jQuery like construction)
|
||||
- **Fully functional DOM** (all the lists, iterators, and events you know)
|
||||
- **Form submission** (easily log in everywhere)
|
||||
- **Navigation** (a `BrowsingContext` is like a browser tab - control it from .NET!).
|
||||
- **LINQ enhanced** (use LINQ with DOM elements, naturally without wrappers)
|
||||
|
||||
The advantage over similar libraries like *HtmlAgilityPack* is that the exposed DOM is using the official W3C specified API, i.e., that even things like `querySelectorAll` are available in AngleSharp. Also the parser uses the HTML 5.1 specification, which defines error handling and element correction. The AngleSharp library focuses on standards compliance, interactivity, and extensibility. It is therefore giving web developers working with C# all possibilities as they know from using the DOM in any modern browser.
|
||||
|
||||
The performance of AngleSharp is quite close to the performance of browsers. Even very large pages can be processed within milliseconds. AngleSharp tries to minimize memory allocations and reuses elements internally to avoid unnecessary object creation.
|
||||
|
||||
## Simple Demo
|
||||
|
||||
The simple example will use the website of Wikipedia for data retrieval.
|
||||
|
||||
```cs
|
||||
var config = Configuration.Default.WithDefaultLoader();
|
||||
var address = "https://en.wikipedia.org/wiki/List_of_The_Big_Bang_Theory_episodes";
|
||||
var context = BrowsingContext.New(config);
|
||||
var document = await context.OpenAsync(address);
|
||||
var cellSelector = "tr.vevent td:nth-child(3)";
|
||||
var cells = document.QuerySelectorAll(cellSelector);
|
||||
var titles = cells.Select(m => m.TextContent);
|
||||
```
|
||||
|
||||
Or the same with explicit types:
|
||||
|
||||
```cs
|
||||
IConfiguration config = Configuration.Default.WithDefaultLoader();
|
||||
string address = "https://en.wikipedia.org/wiki/List_of_The_Big_Bang_Theory_episodes";
|
||||
IBrowsingContext context = BrowsingContext.New(config);
|
||||
IDocument document = await context.OpenAsync(address);
|
||||
string cellSelector = "tr.vevent td:nth-child(3)";
|
||||
IHtmlCollection<IElement> cells = document.QuerySelectorAll(cellSelector);
|
||||
IEnumerable<string> titles = cells.Select(m => m.TextContent);
|
||||
```
|
||||
|
||||
In the example we see:
|
||||
|
||||
* How to setup the configuration for supporting document loading
|
||||
* Asynchronously get the document in a new context using the configuration
|
||||
* Performing a query to get all cells with the content of interest
|
||||
* The whole DOM supports LINQ queries
|
||||
|
||||
Every collection in AngleSharp supports LINQ statements. AngleSharp also provides many useful extension methods for element collections that cannot be found in the official DOM.
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
AngleSharp has been created as a .NET Standard 2.0 compatible library. This includes, but is not limited to:
|
||||
|
||||
- .NET Core (2.0 and later)
|
||||
- .NET Framework (4.6.1 and later)
|
||||
- Xamarin.Android (7.0 and 8.0)
|
||||
- Xamarin.iOS (10.0 and 10.14)
|
||||
- Xamarin.Mac (3.0 and 3.8)
|
||||
- Mono (4.6 and 5.4)
|
||||
- UWP (10.0 and 10.0.16299)
|
||||
- Unity (2018.1)
|
||||
|
||||
## Documentation
|
||||
|
||||
The documentation of AngleSharp is located [in the docs folder](docs/README.md). More examples, best-practices, and general information can be found there. The documentation also contains a list of [frequently asked questions](docs/tutorials/06-Questions.md).
|
||||
|
||||
More information is also available by following some of the hyper references mentioned in the Wiki. In-depth articles will be published on the CodeProject, with links being placed in the Wiki at GitHub.
|
||||
|
||||
## Use-Cases
|
||||
|
||||
- Parsing HTML (incl. fragments)
|
||||
- Parsing CSS (incl. selectors, declarations, ...)
|
||||
- Constructing HTML (e.g., view-engine)
|
||||
- Minifying CSS, HTML, ...
|
||||
- Querying document elements
|
||||
- Crawling information
|
||||
- Gathering statistics
|
||||
- Web automation
|
||||
- Tools with HTML / CSS / ... support
|
||||
- Connection to page analytics
|
||||
- HTML / DOM unit tests
|
||||
- Automated JavaScript interaction
|
||||
- Testing other concepts, e.g., script engines
|
||||
- ...
|
||||
|
||||
## Vision
|
||||
|
||||
The project aims to bring a solid implementation of the W3C DOM for HTML, SVG, MathML, and CSS to the CLR - all written in C#. The idea is that you can basically do everything with the DOM in C# that you can do in JavaScript (plus, of course, more).
|
||||
|
||||
Most parts of the DOM are included, even though some may still miss their (fully specified / correct) implementation. The goal for v1.0 is to have *all practically relevant* parts implemented according to the official W3C specification (with useful extensions by the WHATWG).
|
||||
|
||||
The API is close to the DOM4 specification, however, the naming has been adjusted to apply with .NET conventions. Nevertheless, to make AngleSharp really useful for, e.g., a JavaScript engine, attributes have been placed on the corresponding interfaces (and methods, properties, ...) to indicate the status of the field in the official specification. This allows automatic generation of DOM objects with the official API.
|
||||
|
||||
This is a long-term project which will eventually result in a state of the art parser for the most important angle bracket based hyper-texts.
|
||||
|
||||
Our hope is to build a community around web parsing and libraries from this project. So far we had great contributions, but that goal was not fully achieved. Want to help? Get in touch with us!
|
||||
|
||||
## Participating in the Project
|
||||
|
||||
If you know some feature that AngleSharp is currently missing, and you are willing to implement the feature, then your contribution is more than welcome! Also if you have a really cool idea - do not be shy, we'd like to hear it.
|
||||
|
||||
If you have an idea how to improve the API (or what is missing) then posts / messages are also welcome. For instance there have been ongoing discussions about some styles that have been used by AngleSharp (e.g., `HTMLDocument` or `HtmlDocument`) in the past. In the end AngleSharp stopped using `HTMLDocument` (at least visible outside of the library). Now AngleSharp uses names like `IDocument`, `IHtmlElement` and so on. This change would not have been possible without such fruitful discussions.
|
||||
|
||||
The project is always searching for additional contributors. Even if you do not have any code to contribute, but rather an idea for improvement, a bug report or a mistake in the documentation. These are the contributions that keep this project active.
|
||||
|
||||
Live discussions can take place in our [Gitter chat](https://gitter.im/AngleSharp/AngleSharp), which supports using GitHub accounts.
|
||||
|
||||
More information is found in the [contribution guidelines](.github/CONTRIBUTING.md). All contributors can be found [in the CONTRIBUTORS](CONTRIBUTORS.md) file.
|
||||
|
||||
This project has also adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
|
||||
|
||||
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
|
||||
|
||||
## Funding / Support
|
||||
|
||||
If you use AngleSharp frequently, but you do not have the time to support the project by active participation you may still be interested to ensure that the AngleSharp projects keeps the lights on.
|
||||
|
||||
Therefore we created a backing model via [Bountysource](https://salt.bountysource.com/teams/anglesharp). Any donation is welcome and much appreciated. We will mostly spend the money on dedicated development time to improve AngleSharp where it needs to be improved, plus invest in the web utility eco-system in .NET (e.g., in JavaScript engines, other parsers, or a renderer for AngleSharp to mention some outstanding projects).
|
||||
|
||||
> Visit [Bountysource](https://salt.bountysource.com/teams/anglesharp) for more details.
|
||||
|
||||
## Development
|
||||
|
||||
AngleSharp is written in the most recent version of C# and thus requires Roslyn as a compiler. Using an IDE like Visual Studio 2019+ is recommended on Windows. Alternatively, VSCode (with OmniSharp or another suitable Language Server Protocol implementation) should be the tool of choice on other platforms.
|
||||
|
||||
The code tries to be as clean as possible. Notably the following rules are used:
|
||||
|
||||
- Use braces for any conditional / loop body
|
||||
- Use the `-Async` suffixed methods when available
|
||||
- Use VIP ("Var If Possible") style (in C++ called AAA: Almost Always Auto) to place types on the right
|
||||
|
||||
More important, however, is the proper usage of tests. Any new feature should come with a set of tests to cover the functionality and prevent regression.
|
||||
|
||||
## Changelog
|
||||
|
||||
A very detailed [changelog](CHANGELOG.md) exists. If you are just interested in major releases then have a look at [the GitHub releases](https://github.com/AngleSharp/AngleSharp/releases).
|
||||
|
||||
## .NET Foundation
|
||||
|
||||
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).
|
||||
|
||||
## License
|
||||
|
||||
AngleSharp is released using the MIT license. For more information see the [license file](./LICENSE).
|
||||
Binary file not shown.
@@ -1 +0,0 @@
|
||||
ziiduOsv2cM5Gip8AeXDAEp8EXmdHdsD8DsDSwsOaoNvvm8JDVCTvaJggh4mED+srpmlVdK+7wMl0TyJwdv8Cg==
|
||||
27991
offline/packages/anglesharp/1.1.1/lib/net461/AngleSharp.xml
vendored
27991
offline/packages/anglesharp/1.1.1/lib/net461/AngleSharp.xml
vendored
File diff suppressed because it is too large
Load Diff
27991
offline/packages/anglesharp/1.1.1/lib/net472/AngleSharp.xml
vendored
27991
offline/packages/anglesharp/1.1.1/lib/net472/AngleSharp.xml
vendored
File diff suppressed because it is too large
Load Diff
27991
offline/packages/anglesharp/1.1.1/lib/net6.0/AngleSharp.xml
vendored
27991
offline/packages/anglesharp/1.1.1/lib/net6.0/AngleSharp.xml
vendored
File diff suppressed because it is too large
Load Diff
27991
offline/packages/anglesharp/1.1.1/lib/net7.0/AngleSharp.xml
vendored
27991
offline/packages/anglesharp/1.1.1/lib/net7.0/AngleSharp.xml
vendored
File diff suppressed because it is too large
Load Diff
27991
offline/packages/anglesharp/1.1.1/lib/net8.0/AngleSharp.xml
vendored
27991
offline/packages/anglesharp/1.1.1/lib/net8.0/AngleSharp.xml
vendored
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
BIN
offline/packages/anglesharp/1.1.1/logo.png
vendored
BIN
offline/packages/anglesharp/1.1.1/logo.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 4.4 KiB |
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "zy8TMeTP+1FH2NrLaNZtdRbBdq7u5MI+NFZQOBSM69u5RFkciinwzV2eveY6Kjf5MzgsYvvl6kTStsj3JrXqkg==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
Binary file not shown.
@@ -1,25 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>BouncyCastle.Cryptography</id>
|
||||
<version>2.5.1</version>
|
||||
<title>BouncyCastle.NET Cryptography</title>
|
||||
<authors>Legion of the Bouncy Castle Inc.</authors>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>packageIcon.png</icon>
|
||||
<readme>README.md</readme>
|
||||
<projectUrl>https://www.bouncycastle.org/stable/nuget/csharp/website</projectUrl>
|
||||
<iconUrl>https://www.bouncycastle.org/stable/nuget/csharp/packageIcon.png</iconUrl>
|
||||
<description>BouncyCastle.NET is a popular cryptography library for .NET</description>
|
||||
<releaseNotes>https://www.bouncycastle.org/stable/nuget/csharp/release_notes</releaseNotes>
|
||||
<copyright>Copyright © Legion of the Bouncy Castle Inc. 2000-2024</copyright>
|
||||
<tags>bouncycastle cryptography dtls encryption open-source openpgp post-quantum security tls</tags>
|
||||
<repository type="git" url="https://github.com/bcgit/bc-csharp" branch="refs/heads/release/v2.5" commit="71250c8b20b4a98cf7574febf2fc216763e4ca6a" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.1" />
|
||||
<group targetFramework="net6.0" />
|
||||
<group targetFramework=".NETStandard2.0" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -1,13 +0,0 @@
|
||||
Copyright (c) 2000-2024 The Legion of the Bouncy Castle Inc. (https://www.bouncycastle.org).
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
||||
associated documentation files (the "Software"), to deal in the Software without restriction,
|
||||
including without limitation the rights to use, copy, modify, merge, publish, distribute,
|
||||
sub license, and/or sell copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions: The above copyright notice and this
|
||||
permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
|
||||
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
||||
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
|
||||
OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.**
|
||||
@@ -1,45 +0,0 @@
|
||||
# The Bouncy Castle Cryptography Library For .NET
|
||||
[](https://www.nuget.org/packages/BouncyCastle.Cryptography) [](https://www.nuget.org/packages/BouncyCastle.Cryptography)
|
||||
|
||||
The Bouncy Castle Cryptography library is a .NET implementation of cryptographic algorithms and protocols. It was developed by the Legion of the Bouncy Castle, a registered Australian Charity, with a little help! The Legion, and the latest goings on with this package, can be found at [https://www.bouncycastle.org](https://www.bouncycastle.org).
|
||||
|
||||
In addition to providing basic cryptography algorithms, the package also provides support for CMS, OpenPGP, (D)TLS, TSP, X.509 certificate generation and more. The package also includes implementations of the following NIST Post-Quantum Cryptography Standardization algorithms: CRYSTALS-Dilithium, CRYSTALS-Kyber, Falcon, SPHINCS+, Classic McEliece, FrodoKEM, NTRU, NTRU Prime, Picnic, Saber, BIKE, and SIKE. These should all be considered EXPERIMENTAL and subject to change or removal. SIKE in particular is already slated for removal and should be used for research purposes only.
|
||||
|
||||
The Legion also gratefully acknowledges the contributions made to this package by others (see [here](https://www.bouncycastle.org/csharp/contributors.html) for the current list). If you would like to contribute to our efforts please feel free to get in touch with us or visit our [donations page](https://www.bouncycastle.org/donate), sponsor some specific work, or purchase a [support contract](https://www.keyfactor.com/platform/bouncy-castle-support/).
|
||||
|
||||
Except where otherwise stated, this software is distributed under a license based on the MIT X Consortium license. To view the license, [see here](https://www.bouncycastle.org/licence.html). This software includes a modified Bzip2 library, which is licensed under the [Apache Software License, Version 2.0](http://www.apache.org/licenses/).
|
||||
|
||||
**Note**: This source tree is not the FIPS version of the APIs - if you are interested in our FIPS version please visit us [here](https://www.bouncycastle.org/fips-csharp) or contact us directly at [office@bouncycastle.org](mailto:office@bouncycastle.org).
|
||||
|
||||
## Installing BouncyCastle
|
||||
You should install [BouncyCastle with NuGet:](https://www.nuget.org/packages/BouncyCastle.Cryptography)
|
||||
|
||||
Install-Package BouncyCastle.Cryptography
|
||||
|
||||
Or via the .NET Core command line interface:
|
||||
|
||||
dotnet add package BouncyCastle.Cryptography
|
||||
|
||||
Either commands, from Package Manager Console or .NET Core CLI, will download and install BouncyCastle.Cryptography.
|
||||
|
||||
|
||||
## Mailing Lists
|
||||
|
||||
For those who are interested, there are 2 mailing lists for participation in this project. To subscribe use the links below and include the word subscribe in the message body. (To unsubscribe, replace **subscribe** with **unsubscribe** in the message body)
|
||||
|
||||
* [announce-crypto-csharp-request@bouncycastle.org](mailto:announce-crypto-csharp-request@bouncycastle.org)
|
||||
This mailing list is for new release announcements only, general subscribers cannot post to it.
|
||||
* [dev-crypto-csharp-request@bouncycastle.org](mailto:dev-crypto-csharp-request@bouncycastle.org)
|
||||
This mailing list is for discussion of development of the package. This includes bugs, comments, requests for enhancements, questions about use or operation.
|
||||
|
||||
**NOTE:** You need to be subscribed to send mail to the above mailing list.
|
||||
|
||||
## Feedback
|
||||
|
||||
If you want to provide feedback directly to the members of **The Legion** then please use [feedback-crypto@bouncycastle.org](mailto:feedback-crypto@bouncycastle.org). If you want to help this project survive please consider [donating](https://www.bouncycastle.org/donate).
|
||||
|
||||
For bug reporting/requests you can report issues on [github](https://github.com/bcgit/bc-csharp), or via [feedback-crypto@bouncycastle.org](mailto:feedback-crypto@bouncycastle.org) if required. We will accept pull requests based on this repository as well, but only on the basis that any code included may be distributed under the [Bouncy Castle License](https://www.bouncycastle.org/licence.html).
|
||||
|
||||
## Finally
|
||||
|
||||
Enjoy!
|
||||
Binary file not shown.
@@ -1 +0,0 @@
|
||||
zBLXFaejrNoOUbaASuEOHD6VQwCcEISFrmxOvodz3uV2Qvi+KR3CytzRSghqAjfZJSmJl97YoBpNWngce2erPQ==
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 32 KiB |
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "wHL4tr8mWTvrJt/4sI3raympCNVT4F3VJI4SJHA9A/wB+8Lsq84RFGQH9bHEtvNsN1lCBTKNk+uVoDotGcYJZA==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/cronos/0.10.0/.signature.p7s
vendored
BIN
offline/packages/cronos/0.10.0/.signature.p7s
vendored
Binary file not shown.
30
offline/packages/cronos/0.10.0/Cronos.nuspec
vendored
30
offline/packages/cronos/0.10.0/Cronos.nuspec
vendored
@@ -1,30 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Cronos</id>
|
||||
<version>0.10.0</version>
|
||||
<title>Cronos</title>
|
||||
<authors>Andrey Dorokhov, Sergey Odinokov</authors>
|
||||
<owners>HangfireIO, odinserj</owners>
|
||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>icon.png</icon>
|
||||
<readme>README.md</readme>
|
||||
<projectUrl>https://github.com/HangfireIO/Cronos</projectUrl>
|
||||
<description>A fully-featured .NET library for parsing cron expressions and calculating next occurrences that was designed with time zones in mind and correctly handles daylight saving time transitions.</description>
|
||||
<releaseNotes>https://github.com/HangfireIO/Cronos/releases</releaseNotes>
|
||||
<copyright>Copyright © 2016–2025 Hangfire OÜ.</copyright>
|
||||
<tags>Cronos Cron Recurring</tags>
|
||||
<repository type="git" url="https://github.com/HangfireIO/Cronos.git" commit="d63de9568d5809f1296a36540d1b6163ce480099" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.0" />
|
||||
<group targetFramework=".NETFramework4.5" />
|
||||
<group targetFramework=".NETStandard1.0">
|
||||
<dependency id="NETStandard.Library" version="1.6.1" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0" />
|
||||
<group targetFramework="net6.0" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
21
offline/packages/cronos/0.10.0/LICENSE
vendored
21
offline/packages/cronos/0.10.0/LICENSE
vendored
@@ -1,21 +0,0 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2017 Hangfire OÜ
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
292
offline/packages/cronos/0.10.0/README.md
vendored
292
offline/packages/cronos/0.10.0/README.md
vendored
@@ -1,292 +0,0 @@
|
||||
# Cronos
|
||||
[](https://www.nuget.org/packages/Cronos) [](https://ci.appveyor.com/project/hangfireio/cronos) [](https://sonarcloud.io/summary/new_code?id=HangfireIO_Cronos) [](https://sonarcloud.io/summary/new_code?id=HangfireIO_Cronos) [](https://sonarcloud.io/summary/new_code?id=HangfireIO_Cronos)
|
||||
|
||||
Cronos is a .NET library for parsing Cron expressions and calculating next occurrences. It was designed with time zones in mind, and intuitively handles [Daylight saving time](https://en.wikipedia.org/wiki/Daylight_saving_time) (also known as Summer time) transitions as in *nix Cron.
|
||||
|
||||
*Please note this library doesn't include any task/job scheduler, it only works with Cron expressions.*
|
||||
|
||||
* Supports standard Cron format with optional seconds.
|
||||
* Supports non-standard characters like `L`, `W`, `#` and their combinations.
|
||||
* Supports reversed ranges, like `23-01` (equivalent to `23,00,01`) or `DEC-FEB` (equivalent to `DEC,JAN,FEB`).
|
||||
* Supports time zones, and performs all the date/time conversions for you.
|
||||
* Does not skip occurrences, when the clock jumps forward to Daylight saving time (known as Summer time).
|
||||
* Does not skip interval-based occurrences, when the clock jumps backward from Summer time.
|
||||
* Does not retry non-interval based occurrences, when the clock jumps backward from Summer time.
|
||||
* Contains 1000+ unit tests to ensure everything is working correctly.
|
||||
|
||||
## Compatibility
|
||||
|
||||
This section explains how Cron expressions should be converted, when moving to Cronos.
|
||||
|
||||
Library | Comments
|
||||
--- | ---
|
||||
Vixie Cron | When both day-of-month and day-of-week are specified, Cronos uses AND operator for matching (Vixie Cron uses OR operator for backward compatibility).
|
||||
Quartz.NET | Cronos uses different, but more intuitive Daylight saving time handling logic (as in Vixie Cron). Full month names such as `september` aren't supported. Day-of-week field in Cronos has different values, `0` and `7` stand for Sunday, `1` for Monday, etc. (as in Vixie Cron). Year field is not supported.
|
||||
NCrontab | Compatible
|
||||
CronNET | Compatible
|
||||
|
||||
## Installation
|
||||
|
||||
Cronos is distributed as a [NuGet package](http://www.nuget.org/packages/Cronos/), you can install it from the official NuGet Gallery. Please use the following command to install it using the NuGet Package Manager Console window.
|
||||
|
||||
```
|
||||
PM> Install-Package Cronos
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
We've tried to do our best to make Cronos API as simple and predictable in corner cases as possible. So you can only use `DateTime` with `DateTimeKind.Utc` specified (for example, `DateTime.UtcNow`), or `DateTimeOffset` classes to calculate next occurrences. You **can not use** local `DateTime` objects (such as `DateTime.Now`), because this may lead to ambiguity during DST transitions, and an exception will be thrown if you attempt to use them.
|
||||
|
||||
To calculate the next occurrence, you need to create an instance of the `CronExpression` class, and call its `GetNextOccurrence` method. To learn about Cron format, please refer to the next section.
|
||||
|
||||
```csharp
|
||||
using Cronos;
|
||||
|
||||
CronExpression expression = CronExpression.Parse("* * * * *");
|
||||
|
||||
DateTime? nextUtc = expression.GetNextOccurrence(DateTime.UtcNow);
|
||||
```
|
||||
|
||||
The `nextUtc` will contain the next occurrence in UTC, *after the given time*, or `null` value when it is unreachable (for example, Feb 30). If an invalid Cron expression is given, the `CronFormatException` exception is thrown.
|
||||
|
||||
### Working with time zones
|
||||
|
||||
It is possible to specify a time zone directly, in this case you should pass `DateTime` with `DateTimeKind.Utc` flag, or use `DateTimeOffset` class, that's is smart enough to always point to an exact, non-ambiguous instant.
|
||||
|
||||
```csharp
|
||||
CronExpression expression = CronExpression.Parse("* * * * *");
|
||||
TimeZoneInfo easternTimeZone = TimeZoneInfo.FindSystemTimeZoneById("Eastern Standard Time");
|
||||
|
||||
DateTime? next = expression.GetNextOccurrence(DateTime.UtcNow, easternTimeZone);
|
||||
DateTimeOffset? next = expression.GetNextOccurrence(DateTimeOffset.UtcNow, easternTimeZone);
|
||||
```
|
||||
|
||||
If you passed a `DateTime` object, resulting time will be in UTC. If you used `DateTimeOffset`, resulting object will contain the **correct offset**, so don't forget to use it especially during DST transitions (see below).
|
||||
|
||||
### Working with local time
|
||||
|
||||
If you just want to make all the calculations using local time, you'll have to use the `DateTimeOffset` class, because as I've said earlier, `DateTime` objects may be ambiguous during Summer time transitions. You can get the resulting local time, using the `DateTimeOffset.DateTime` property.
|
||||
|
||||
```csharp
|
||||
CronExpression expression = CronExpression.Parse("* * * * *");
|
||||
DateTimeOffset? next = expression.GetNextOccurrence(DateTimeOffset.Now, TimeZoneInfo.Local);
|
||||
|
||||
var nextLocalTime = next?.DateTime;
|
||||
```
|
||||
|
||||
### Adding seconds to an expression
|
||||
|
||||
If you want to specify seconds, use another overload of the `Parse` method and specify the `CronFormat` argument as below:
|
||||
|
||||
```csharp
|
||||
CronExpression expression = CronExpression.Parse("*/30 * * * * *", CronFormat.IncludeSeconds);
|
||||
DateTime? next = expression.GetNextOccurrence(DateTime.UtcNow);
|
||||
```
|
||||
|
||||
### Getting occurrences within a range
|
||||
|
||||
You can also get occurrences within a fixed date/time range using the `GetOccurrences` method. By default, the `from` argument will be included when matched, and `to` argument will be excluded. However, you can configure that behavior.
|
||||
|
||||
```csharp
|
||||
CronExpression expression = CronExpression.Parse("* * * * *");
|
||||
IEnumerable<DateTime> occurrences = expression.GetOccurrences(
|
||||
DateTime.UtcNow,
|
||||
DateTime.UtcNow.AddYears(1),
|
||||
fromInclusive: true,
|
||||
toInclusive: false);
|
||||
```
|
||||
|
||||
There are different overloads for this method to support `DateTimeOffset` arguments or time zones.
|
||||
|
||||
## Cron format
|
||||
|
||||
Cron expression is a mask to define fixed times, dates and intervals. The mask consists of second (optional), minute, hour, day-of-month, month and day-of-week fields. All of the fields allow you to specify multiple values, and any given date/time will satisfy the specified Cron expression, if all the fields contain a matching value.
|
||||
|
||||
Allowed values Allowed special characters Comment
|
||||
|
||||
┌───────────── second (optional) 0-59 * , - /
|
||||
│ ┌───────────── minute 0-59 * , - /
|
||||
│ │ ┌───────────── hour 0-23 * , - /
|
||||
│ │ │ ┌───────────── day of month 1-31 * , - / L W ?
|
||||
│ │ │ │ ┌───────────── month 1-12 or JAN-DEC * , - /
|
||||
│ │ │ │ │ ┌───────────── day of week 0-6 or SUN-SAT * , - / # L ? Both 0 and 7 means SUN
|
||||
│ │ │ │ │ │
|
||||
* * * * * *
|
||||
|
||||
### Base characters
|
||||
|
||||
In all fields you can use number, `*` to mark field as *any value*, `-` to specify ranges of values. Reversed ranges like `22-1`(equivalent to `22,23,0,1,2`) are also supported.
|
||||
|
||||
It's possible to define **step** combining `/` with `*`, numbers and ranges. For example, `*/5` in minute field describes *every 5 minute* and `1-15/3` in day-of-month field – *every 3 days from the 1st to the 15th*. Pay attention that `*/24` is just equivalent to `0,24,48` and `*/24` in minute field doesn't literally mean *every 24 minutes* it means *every 0,24,48 minute*.
|
||||
|
||||
Concatinate values and ranges by `,`. Comma works like `OR` operator. So `3,5-11/3,12` is equivalent to `3,5,8,11,12`.
|
||||
|
||||
In month and day-of-week fields, you can use names of months or days of weeks abbreviated to first three letters (`Jan-Dec` or `Mon-Sun`) instead of their numeric values. Full names like `JANUARY` or `MONDAY` **aren't supported**.
|
||||
|
||||
For day of week field, both `0` and `7` stays for Sunday, 1 for Monday.
|
||||
|
||||
| Expression | Description |
|
||||
|----------------------|---------------------------------------------------------------------------------------|
|
||||
| `* * * * *` | Every minute |
|
||||
| `0 0 1 * *` | At midnight, on day 1 of every month |
|
||||
| `*/5 * * * *` | Every 5 minutes |
|
||||
| `30,45-15/2 1 * * *` | Every 2 minute from 1:00 AM to 01:15 AM and from 1:45 AM to 1:59 AM and at 1:30 AM |
|
||||
| `0 0 * * MON-FRI` | At 00:00, Monday through Friday |
|
||||
|
||||
### Special characters
|
||||
|
||||
Most expressions you can describe using base characters. If you want to deal with more complex cases like *the last day of month* or *the 2nd Saturday* use special characters:
|
||||
|
||||
**`L`** stands for "last". When used in the day-of-week field, it allows you to specify constructs such as *the last Friday* (`5L`or `FRIL`). In the day-of-month field, it specifies the last day of the month.
|
||||
|
||||
**`W`** in day-of-month field is the nearest weekday. Use `W` with single value (not ranges, steps or `*`) to define *the nearest weekday* to the given day. In this case there are two base rules to determine occurrence: we should shift to **the nearest weekday** and **can't shift to different month**. Thus if given day is Saturday we shift to Friday, if it is Sunday we shift to Monday. **But** if given day is **the 1st day of month** (e.g. `0 0 1W * *`) and it is Saturday we shift to the 3rd Monday, if given day is **last day of month** (`0 0 31W 0 0`) and it is Sunday we shift to that Friday. Mix `L` (optionaly with offset) and `W` characters to specify *last weekday of month* `LW` or more complex like `L-5W`.
|
||||
|
||||
**`#`** in day-of-week field allows to specify constructs such as *second Saturday* (`6#2` or `SAT#2`).
|
||||
|
||||
**`?`** is synonym of `*`. It's supported but not obligatory, so `0 0 5 * ?` is the same as `0 0 5 * *`.
|
||||
|
||||
| Expression | Description |
|
||||
|-------------------|----------------------------------------------------------|
|
||||
| `0 0 L * *` | At 00:00 AM on the last day of the month |
|
||||
| `0 0 L-1 * *` | At 00:00 AM the day before the last day of the month |
|
||||
| `0 0 3W * *` | At 00:00 AM, on the 3rd weekday of every month |
|
||||
| `0 0 LW * *` | At 00:00 AM, on the last weekday of the month |
|
||||
| `0 0 * * 2L` | At 00:00 AM on the last tuesday of the month |
|
||||
| `0 0 * * 6#3` | At 00:00 AM on the third Saturday of the month |
|
||||
| `0 0 ? 1 MON#1` | At 00:00 AM on the first Monday of the January |
|
||||
|
||||
### Specify Day of month and Day of week
|
||||
|
||||
You can set both **day-of-month** and **day-of-week**, it allows you to specify constructs such as **Friday the thirteenth**. Thus `0 0 13 * 5` means at 00:00, Friday the thirteenth.
|
||||
|
||||
It differs from Unix crontab and Quartz cron implementations. Crontab handles it like `OR` operator: occurrence can happen in given day of month or given day of week. So `0 0 13 * 5` means *at 00:00 AM, every friday or every the 13th of a month*. Quartz doesn't allow specify both day-of-month and day-of-week.
|
||||
|
||||
### Macro
|
||||
|
||||
A macro is a string starting with `@` and representing a shortcut for simple cases like *every day* or *every minute*.
|
||||
|
||||
Macro | Equivalent | Comment
|
||||
----------------|---------------| -------
|
||||
`@every_second` | `* * * * * *` | Run once a second
|
||||
`@every_minute` | `* * * * *` | Run once a minute at the beginning of the minute
|
||||
`@hourly` | `0 * * * *` | Run once an hour at the beginning of the hour
|
||||
`@daily` | `0 0 * * *` | Run once a day at midnight
|
||||
`@midnight` | `0 0 * * *` | Run once a day at midnight
|
||||
`@weekly` | `0 0 * * 0` | Run once a week at midnight on Sunday morning
|
||||
`@monthly` | `0 0 1 * *` | Run once a month at midnight of the first day of the month
|
||||
`@yearly` | `0 0 1 1 *` | Run once a year at midnight of 1 January
|
||||
`@annually` | `0 0 1 1 *` | Run once a year at midnight of 1 January
|
||||
|
||||
### Cron grammar
|
||||
|
||||
Cronos parser uses following case-insensitive grammar:
|
||||
|
||||
```
|
||||
cron ::= expression | macro
|
||||
expression ::= [second space] minute space hour space day-of-month space month space day-of-week
|
||||
second ::= field
|
||||
minute ::= field
|
||||
hour ::= field
|
||||
day-of-month ::= '*' [step] | '?' [step] | lastday | value [ 'W' | range [list] ]
|
||||
month ::= field
|
||||
day-of-week ::= '*' [step] | '?' [step] | value [ dowspec | range [list] ]
|
||||
macro ::= '@every_second' | '@every_minute' | '@hourly' | '@daily' | '@midnight' | '@weekly' | '@monthly'|
|
||||
'@yearly' | '@annually'
|
||||
field ::= '*' [step] | '?' [step] | value [range] [list]
|
||||
list ::= { ',' value [range] }
|
||||
range ::= '-' value [step] | [step]
|
||||
step ::= '/' number
|
||||
value ::= number | name
|
||||
name ::= month-name | dow-name
|
||||
month-name ::= 'JAN' | 'FEB' | 'MAR' | 'APR' | 'MAY' | 'JUN' | 'JUL' | 'AUG' | 'SEP' | 'OCT' | 'NOV' | 'DEC'
|
||||
dow-name ::= 'SUN' | 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT'
|
||||
dowspec ::= 'L' | '#' number
|
||||
lastday ::= 'L' ['-' number] ['W']
|
||||
number ::= digit | number digit
|
||||
space ::= ' ' | '\t'
|
||||
```
|
||||
|
||||
## Daylight Saving Time
|
||||
|
||||
Cronos is the only library to handle daylight saving time transitions in intuitive way with the same behavior as Vixie Cron (utility for *nix systems). During a spring transition, we don't skip occurrences scheduled to invalid time during. In an autumn transition we don't get duplicate occurrences for daily expressions, and don't skip interval expressions when the local time is ambiguous.
|
||||
|
||||
### Transition to Summer time (in spring)
|
||||
|
||||
During the transition to Summer time, the clock is moved forward, for example the next minute after `01:59 AM` is `03:00 AM`. So any daily Cron expression that should match `02:30 AM`, points to an invalid time. It doesn't exist, and can't be mapped to UTC.
|
||||
|
||||
Cronos adjusts the next occurrence to the next valid time in these cases. If you use Cron to schedule jobs, you may have shorter or longer intervals between runs when this happen, but you'll not lose your jobs:
|
||||
|
||||
```
|
||||
"30 02 * * *" (every day at 02:30 AM)
|
||||
|
||||
Mar 13, 02:30 +03:00 – run
|
||||
Mar 14, 03:00 +04:00 – run (adjusted)
|
||||
Mar 15, 02:30 +04:00 – run
|
||||
```
|
||||
|
||||
### Transition from Summer time (in autumn)
|
||||
|
||||
When Daylight Saving Time ends you set the clocks backward so there is duration which repeats twice. For example, after `01:59 AM` you get `01:00 AM` again, so the interval between `01:00 AM` to `02:00 AM` (excluding) is ambiguous, and can be mapped to multiple UTC offsets.
|
||||
|
||||
We don't want to have multiple occurrences of daily expressions during this transition, but at the same time we want to schedule interval expressions as usually, without skipping them. So we have different behavior for different Cron expressions.
|
||||
|
||||
#### Interval expression
|
||||
|
||||
Cron expression is **interval based** whose second, minute or hour field contains `*`, ranges or steps, e.g. `30 * * * *` (hour field), `* 1 * * *` (minute field), `0,5 0/10 1 * * *`. In this case there are expectations that occurrences should happen periodically during the day and this rule can't be broken by time transitions. Thus for **interval based** expressions occurrences will be before and after clock shifts.
|
||||
|
||||
Consider `*/30 * * * *` interval expression. It should occur every 30 minutes no matter what.
|
||||
|
||||
```
|
||||
Nov 08, 00:30 +04:00 – run
|
||||
Nov 08, 01:00 +04:00 – run
|
||||
Nov 08, 01:30 +04:00 – run
|
||||
Nov 08, 01:00 +03:00 – run
|
||||
Nov 08, 01:30 +03:00 – run
|
||||
Nov 08, 02:00 +03:00 – run
|
||||
```
|
||||
|
||||
#### Non-interval expression
|
||||
|
||||
Cron expression is **non-interval based** whose second, minute or hour field **does not contain** `*`, ranges or steps, e.g. `0 30 1 * * *` or `0 0,45 1,2 * * *`. We expect they occur given number of times per day. Thus for **non-interval** expressions occurrences will be just before clock shifts.
|
||||
|
||||
Consider `30 1 * * *` non-interval expression. It should occur once a day no matter what.
|
||||
|
||||
```
|
||||
Nov 07, 01:30 +04:00 – run
|
||||
Nov 08, 01:30 +04:00 – run
|
||||
Nov 08, 01:30 +03:00 – skip
|
||||
Nov 09, 01:30 +03:00 – run
|
||||
```
|
||||
|
||||
## Benchmarks
|
||||
|
||||
Since [BenchmarkDotNet](https://github.com/dotnet/BenchmarkDotNet) project appeared, it's hard to ignore the performance. We tried hard to make Cronos not only feature-rich, but also really fast when parsing expressions and calculating next occurrences. As a result, Cronos is faster more than in an order of magnitude than alternative libraries, here is a small comparison:
|
||||
|
||||
```
|
||||
Cronos Method | Mean | StdDev
|
||||
------------------------------------------- | -------------- | -------------
|
||||
CronExpression.Parse("* * * * *") | 30.8473 ns | 0.0515 ns
|
||||
CronExpression.Parse("*/10 12-20 ? DEC 3") | 81.5010 ns | 0.0924 ns
|
||||
Simple.GetNextOccurrence(DateTime.UtcNow) | 123.4712 ns | 0.5928 ns
|
||||
Complex.GetNextOccurrence(DateTime.UtcNow) | 212.0422 ns | 0.3997 ns
|
||||
|
||||
NCrontab Method | Mean | StdDev
|
||||
------------------------------------------- | -------------- | -------------
|
||||
CrontabSchedule.Parse("* * * * *") | 1,813.7313 ns | 3.3718 ns
|
||||
CrontabSchedule.Parse("*/10 12-20 * DEC 3") | 3,174.3625 ns | 6.8522 ns
|
||||
Simple.GetNextOccurrence(DateTime.UtcNow) | 147.7866 ns | 0.1689 ns
|
||||
Complex.GetNextOccurrence(DateTime.UtcNow) | 1,001.3253 ns | 1.6205 ns
|
||||
|
||||
Quartz Method | Mean | StdDev
|
||||
------------------------------------------- | -------------- | -------------
|
||||
new CronExpression("* * * * * ?") | 48,157.7744 ns | 1,417.3101 ns
|
||||
new CronExpression("* */10 12-20 ? DEC 3") | 33,731.9992 ns | 38.3192 ns
|
||||
Simple.GetTimeAfter(DateTimeOffset.Now) | 1,416.9867 ns | 1.2784 ns
|
||||
Complex.GetTimeAfter(DateTimeOffset.Now) | 6,573.0269 ns | 7.9192 ns
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Copyright © 2017 Hangfire OÜ. Cronos is licensed under [The MIT License (MIT)][LICENSE].
|
||||
|
||||
[LICENSE]:LICENSE
|
||||
BIN
offline/packages/cronos/0.10.0/cronos.0.10.0.nupkg
vendored
BIN
offline/packages/cronos/0.10.0/cronos.0.10.0.nupkg
vendored
Binary file not shown.
@@ -1 +0,0 @@
|
||||
64VD5LS+VkoELCZnpOPRbc/jtYbKFdNFIykE/Pm7O+XB0zbwZyDQmrwYeQN6BLmmmevW/zDhBsK91Yrh0vinjQ==
|
||||
BIN
offline/packages/cronos/0.10.0/icon.png
vendored
BIN
offline/packages/cronos/0.10.0/icon.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 2.2 KiB |
211
offline/packages/cronos/0.10.0/lib/net40/Cronos.xml
vendored
211
offline/packages/cronos/0.10.0/lib/net40/Cronos.xml
vendored
@@ -1,211 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
211
offline/packages/cronos/0.10.0/lib/net45/Cronos.xml
vendored
211
offline/packages/cronos/0.10.0/lib/net45/Cronos.xml
vendored
@@ -1,211 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
211
offline/packages/cronos/0.10.0/lib/net6.0/Cronos.xml
vendored
211
offline/packages/cronos/0.10.0/lib/net6.0/Cronos.xml
vendored
@@ -1,211 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,208 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,211 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Cronos</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Cronos.CronExpression">
|
||||
<summary>
|
||||
Provides a parser and scheduler for cron expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Yearly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on Jan 1st every year at midnight.
|
||||
Equals to "0 0 1 1 *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Weekly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every Sunday at midnight.
|
||||
Equals to "0 0 * * 0".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Monthly">
|
||||
<summary>
|
||||
Represents a cron expression that fires on 1st day of every month at midnight.
|
||||
Equals to "0 0 1 * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Daily">
|
||||
<summary>
|
||||
Represents a cron expression that fires every day at midnight.
|
||||
Equals to "0 0 * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.Hourly">
|
||||
<summary>
|
||||
Represents a cron expression that fires every hour at the beginning of the hour.
|
||||
Equals to "0 * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EveryMinute">
|
||||
<summary>
|
||||
Represents a cron expression that fires every minute.
|
||||
Equals to "* * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronExpression.EverySecond">
|
||||
<summary>
|
||||
Represents a cron expression that fires every second.
|
||||
Equals to "* * * * * *".
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 fields:
|
||||
minute, hour, day of month, month, day of week.
|
||||
If you want to parse non-standard cron expressions use <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/> with specified CronFields argument.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified
|
||||
cron expression. It's supported expressions consisting of 5 or 6 fields:
|
||||
second (optional), minute, hour, day of month, month, day of week.
|
||||
See more: <a href="https://github.com/HangfireIO/Cronos">https://github.com/HangfireIO/Cronos</a>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the
|
||||
<see cref="F:Cronos.CronFormat.Standard"/> format.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.TryParse(System.String,Cronos.CronFormat,Cronos.CronExpression@)">
|
||||
<summary>
|
||||
Constructs a new <see cref="T:Cronos.CronExpression"/> based on the specified cron expression with the specified
|
||||
<paramref name="format"/>.
|
||||
A return value indicates whether the operation succeeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in UTC time zone.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTime,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="fromUtc"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetNextOccurrence(System.DateTimeOffset,System.TimeZoneInfo,System.Boolean)">
|
||||
<summary>
|
||||
Calculates next occurrence starting with <paramref name="from"/> (optionally <paramref name="inclusive"/>) in given <paramref name="zone"/>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range,
|
||||
including <paramref name="fromUtc"/> and excluding <paramref name="toUtc"/>
|
||||
by default, and UTC time zone. When none of the occurrences found, an
|
||||
empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTime,System.DateTime,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of next occurrences within the given date/time range, including
|
||||
<paramref name="fromUtc"/> and excluding <paramref name="toUtc"/> by default, and
|
||||
specified time zone. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetOccurrences(System.DateTimeOffset,System.DateTimeOffset,System.TimeZoneInfo,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Returns the list of occurrences within the given date/time offset range,
|
||||
including <paramref name="from"/> and excluding <paramref name="to"/> by
|
||||
default. When none of the occurrences found, an empty list is returned.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException"/>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.ToString">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(Cronos.CronExpression)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
|
||||
</summary>
|
||||
<param name="other">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
|
||||
</summary>
|
||||
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
|
||||
<returns>
|
||||
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance;
|
||||
otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.GetHashCode">
|
||||
<summary>
|
||||
Returns a hash code for this instance.
|
||||
</summary>
|
||||
<returns>
|
||||
A hash code for this instance, suitable for use in hashing algorithms and data
|
||||
structures like a hash table.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Equality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator ==.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronExpression.op_Inequality(Cronos.CronExpression,Cronos.CronExpression)">
|
||||
<summary>
|
||||
Implements the operator !=.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormat">
|
||||
<summary>
|
||||
Defines the cron format options that customize string parsing for <see cref="M:Cronos.CronExpression.Parse(System.String,Cronos.CronFormat)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.Standard">
|
||||
<summary>
|
||||
Parsing string must contain only 5 fields: minute, hour, day of month, month, day of week.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Cronos.CronFormat.IncludeSeconds">
|
||||
<summary>
|
||||
Second field must be specified in parsing string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Cronos.CronFormatException">
|
||||
<summary>
|
||||
Represents an exception that's thrown, when invalid Cron expression is given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.String,System.Exception)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Cronos.CronFormatException"/> class with
|
||||
a specified error message and a reference to the inner exception that is the
|
||||
cause of this exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Cronos.CronFormatException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "4H/f2uYJOZ+YObZjpY9ABrKZI+JNw3uizp6oMzTXwDw6F+2qIPhpRl/1t68O/6e98+vqNiYGu+lswmwdYUy3gg==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/dnsclient/1.6.1/.signature.p7s
vendored
BIN
offline/packages/dnsclient/1.6.1/.signature.p7s
vendored
Binary file not shown.
@@ -1,45 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>DnsClient</id>
|
||||
<version>1.6.1</version>
|
||||
<authors>MichaCo</authors>
|
||||
<license type="expression">Apache-2.0</license>
|
||||
<licenseUrl>https://licenses.nuget.org/Apache-2.0</licenseUrl>
|
||||
<icon>icon.png</icon>
|
||||
<projectUrl>http://dnsclient.michaco.net/</projectUrl>
|
||||
<description>DnsClient.NET is a simple yet very powerful and high performance open source library for the .NET Framework to do DNS lookups</description>
|
||||
<copyright>Copyright (c) 2021 Michael Conrad</copyright>
|
||||
<tags>dns client stub resolver name server core service discovery</tags>
|
||||
<repository type="git" url="https://github.com/MichaCo/DnsClient.NET" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.5">
|
||||
<dependency id="System.Buffers" version="4.5.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETFramework4.7.1">
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Buffers" version="4.5.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard1.3">
|
||||
<dependency id="Microsoft.Win32.Primitives" version="4.3.0" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
<dependency id="NETStandard.Library" version="1.6.1" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Buffers" version="4.5.1" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Diagnostics.TraceSource" version="4.3.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Globalization.Extensions" version="4.3.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Net.NameResolution" version="4.3.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Net.NetworkInformation" version="4.3.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net5.0">
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
<dependency id="System.Buffers" version="4.5.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1">
|
||||
<dependency id="Microsoft.Win32.Registry" version="5.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
Binary file not shown.
@@ -1 +0,0 @@
|
||||
zFRP0MFIwSEYYo6wcLc7bFJANsVY6tj08Vkq+8x6xbz0hvYqTmMM76Eg9mbzoWbDuJWWrWIDlmt/Ia7HwrPVXg==
|
||||
BIN
offline/packages/dnsclient/1.6.1/icon.png
vendored
BIN
offline/packages/dnsclient/1.6.1/icon.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB |
5071
offline/packages/dnsclient/1.6.1/lib/net45/DnsClient.xml
vendored
5071
offline/packages/dnsclient/1.6.1/lib/net45/DnsClient.xml
vendored
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "yJrbImpXdJAwKoa0FOgK3JV4wuOPHhKI1vWmNepJD5U/t6ENwEr0FX6gl06rIxxKbVGrKCd8JMmm7rieT/4dIw==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
offline/packages/esprima/3.0.5/.signature.p7s
vendored
BIN
offline/packages/esprima/3.0.5/.signature.p7s
vendored
Binary file not shown.
25
offline/packages/esprima/3.0.5/Esprima.nuspec
vendored
25
offline/packages/esprima/3.0.5/Esprima.nuspec
vendored
@@ -1,25 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Esprima</id>
|
||||
<version>3.0.5</version>
|
||||
<authors>Sebastien Ros</authors>
|
||||
<license type="expression">BSD-3-Clause</license>
|
||||
<licenseUrl>https://licenses.nuget.org/BSD-3-Clause</licenseUrl>
|
||||
<readme>README.md</readme>
|
||||
<projectUrl>https://github.com/sebastienros/esprima-dotnet</projectUrl>
|
||||
<description>Standard-compliant ECMAScript 2022 parser (also known as JavaScript).</description>
|
||||
<copyright>Sebastien Ros</copyright>
|
||||
<tags>javascript, parser, ecmascript</tags>
|
||||
<repository type="git" url="https://github.com/sebastienros/esprima-dotnet" commit="4661614f09d4bb476a552f8dae82a5887060d570" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="System.Memory" version="4.5.5" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="System.Memory" version="4.5.5" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
100
offline/packages/esprima/3.0.5/README.md
vendored
100
offline/packages/esprima/3.0.5/README.md
vendored
@@ -1,100 +0,0 @@
|
||||
| :mega: Important notices |
|
||||
|--------------|
|
||||
|If you are upgrading from an older version, please note that version 3 ships with numerous breaking changes to the public API because virtually all areas of the library have been revised.<br />Documentation of the previous major version is available [here](https://github.com/sebastienros/esprima-dotnet/tree/v2.1.3). |
|
||||
|
||||
[](https://github.com/sebastienros/esprima-dotnet/actions/workflows/build.yml)
|
||||
[](https://www.nuget.org/packages/esprima)
|
||||
[](https://www.myget.org/feed/esprimadotnet/package/nuget/Esprima)
|
||||
|
||||
**Esprima .NET** (BSD license) is a .NET port of the [esprima.org](http://esprima.org) project.
|
||||
It is a standard-compliant [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm)
|
||||
parser (also popularly known as
|
||||
[JavaScript](https://en.wikipedia.org/wiki/JavaScript)).
|
||||
|
||||
### Features
|
||||
|
||||
- Full support for ECMAScript 2022 ([ECMA-262 13th Edition](http://www.ecma-international.org/publications/standards/Ecma-262.htm))
|
||||
- Support for a few upcoming (stage 3+ proposal) ECMAScript features:
|
||||
- [Decorators](https://github.com/tc39/proposal-decorators),
|
||||
- [Import attributes](https://github.com/tc39/proposal-import-attributes),
|
||||
- [Duplicate named capturing groups in regular expressions](https://github.com/tc39/proposal-duplicate-named-capturing-groups).
|
||||
- Experimental support for [JSX](https://facebook.github.io/jsx/), a syntax extension for [React](https://facebook.github.io/react/)
|
||||
- Sensible [syntax tree format](https://github.com/estree/estree/blob/master/es5.md), which is based on the standard established by the [ESTree project](https://github.com/estree/estree)
|
||||
- Tracking of syntax node location (index-based and line-column)
|
||||
- Heavily tested
|
||||
|
||||
### API
|
||||
|
||||
Esprima can be used to perform [lexical analysis](https://en.wikipedia.org/wiki/Lexical_analysis) (tokenization) or [syntactic analysis](https://en.wikipedia.org/wiki/Parsing) (parsing) of a JavaScript program.
|
||||
|
||||
A simple C# example:
|
||||
|
||||
```csharp
|
||||
var parser = new JavaScriptParser();
|
||||
var program = parser.ParseScript("const answer = 42");
|
||||
```
|
||||
|
||||
You can control the behavior of the parser by initializing and passing a `ParserOptions` to the parser's constructor. (For the available options, see the XML documentation of the `ParserOptions` class.)
|
||||
|
||||
Instead of `ParseScript`, you may use `ParseModule` or `ParseExpression` to make the parser treat the input as an ES6 module or as a plain JavaScript expression respectively.
|
||||
|
||||
In case the input is syntactically correct, each of these methods returns the root node of the resulting *abstract syntax tree (AST)*, which you can freely analyze or transform. The library provides the `AstVisitor` and `AstRewriter` visitor classes to help you with such tasks.
|
||||
|
||||
When the input contains a severe syntax error, a `ParserException` is thrown. By catching it you can get details about the error. There are syntax errors though which can be tolerated by the parser. Such errors are ignored by default. You can record them by setting `ParserOptions.ErrorHandler` to an instance of `CollectingErrorHandler`. Alternatively, you can set `ParserOptions.Tolerant` to false to make the parser throw exceptions also in the case of tolerable syntax errors.
|
||||
|
||||
The library is able to write the AST (except for comments) back to JavaScript code:
|
||||
|
||||
```csharp
|
||||
var code = program.ToJavaScriptString(format: true);
|
||||
```
|
||||
|
||||
It is also possible to serialize the AST into a JSON representation:
|
||||
|
||||
```csharp
|
||||
var astJson = program.ToJsonString(indent: " ");
|
||||
```
|
||||
|
||||
Considering the example above this call will return the following JSON:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Program",
|
||||
"body": [
|
||||
{
|
||||
"type": "VariableDeclaration",
|
||||
"declarations": [
|
||||
{
|
||||
"type": "VariableDeclarator",
|
||||
"id": {
|
||||
"type": "Identifier",
|
||||
"name": "answer"
|
||||
},
|
||||
"init": {
|
||||
"type": "Literal",
|
||||
"value": 42,
|
||||
"raw": "42"
|
||||
}
|
||||
}
|
||||
],
|
||||
"kind": "const"
|
||||
}
|
||||
],
|
||||
"sourceType": "script",
|
||||
"strict": false
|
||||
}
|
||||
```
|
||||
|
||||
### Benchmarks
|
||||
|
||||
Here is a list of common JavaScript libraries and the time it takes to parse them,
|
||||
compared to the time it took for the same script using the original Esprima in Chrome.
|
||||
|
||||
| Script | Size | Esprima .NET (.NET 6) | Esprima (Chrome 116) |
|
||||
| ------------------- | ------ | ----------------------| -------------------- |
|
||||
| underscore-1.5.2 | 43 KB | 1.0 ms | 1.4 ms |
|
||||
| backbone-1.1.0 | 59 KB | 1.2 ms | 1.6 ms |
|
||||
| mootools-1.4.5 | 157 KB | 5.2 ms | 7.1 ms |
|
||||
| jquery-1.9.1 | 262 KB | 6.6 ms | 7.9 ms |
|
||||
| yui-3.12.0 | 330 KB | 4.6 ms | 6.9 ms |
|
||||
| jquery.mobile-1.4.2 | 442 KB | 10.0 ms | 17.7 ms |
|
||||
| angular-1.2.5 | 702 KB | 8.5 ms | 15.1 ms |
|
||||
BIN
offline/packages/esprima/3.0.5/esprima.3.0.5.nupkg
vendored
BIN
offline/packages/esprima/3.0.5/esprima.3.0.5.nupkg
vendored
Binary file not shown.
@@ -1 +0,0 @@
|
||||
dR8oKDP+tGZ5N+O4i2mQQEe5FKIP9VH3z33Lk2+IZGu5+JjwM9zzJtBmPqcrUTMpgnRztpfxObxKRbQvmL4d7g==
|
||||
@@ -1,825 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Esprima</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:Esprima.ArrayList`1.#ctor(`0[])">
|
||||
<remarks>
|
||||
Expects ownership of the array!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.ArrayList`1.AsSpan">
|
||||
<remarks>
|
||||
Items should not be added or removed from the <see cref="T:Esprima.ArrayList`1"/> while the returned <see cref="T:System.Span`1"/> is in use!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.ArrayList`1.AsReadOnlySpan">
|
||||
<remarks>
|
||||
Items should not be added or removed from the <see cref="T:Esprima.ArrayList`1"/> while the returned <see cref="T:System.ReadOnlySpan`1"/> is in use!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.ArrayList`1.Enumerator">
|
||||
<remarks>
|
||||
This implementation does not detect changes to the list
|
||||
during iteration and therefore the behaviour is undefined
|
||||
under those conditions.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrayExpression.Elements">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Expression"/> (incl. <see cref="T:Esprima.Ast.SpreadElement"/>) | <see langword="null"/> (omitted element) }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrayPattern.Elements">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> | <see langword="null"/> (omitted element) }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrowFunctionExpression.Params">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrowFunctionExpression.Body">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.BlockStatement"/> | <see cref="T:Esprima.Ast.Expression"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.ArrowParameterPlaceHolder">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.ArrowParameterPlaceHolder"/> nodes never appear in the final AST, only used during its construction.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.AssignmentExpression.Left">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.AssignmentPattern.Left">
|
||||
<summary>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.CatchClause.Param">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ChainExpression.Expression">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.CallExpression"/> | <see cref="T:Esprima.Ast.ComputedMemberExpression"/>| <see cref="T:Esprima.Ast.StaticMemberExpression"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ClassBody.Body">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.MethodDefinition"/> | <see cref="T:Esprima.Ast.PropertyDefinition"/> | <see cref="T:Esprima.Ast.StaticBlock"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ClassProperty.Key">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string or numeric) | '[' <see cref="T:Esprima.Ast.Expression"/> ']' | <see cref="T:Esprima.Ast.PrivateIdentifier"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportAllDeclaration.Exported">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportDefaultDeclaration.Declaration">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Expression"/> | <see cref="T:Esprima.Ast.ClassDeclaration"/> | <see cref="T:Esprima.Ast.FunctionDeclaration"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportNamedDeclaration.Declaration">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> | <see cref="T:Esprima.Ast.ClassDeclaration"/> | <see cref="T:Esprima.Ast.FunctionDeclaration"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportSpecifier.Local">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportSpecifier.Exported">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.Expression">
|
||||
<summary>
|
||||
A JavaScript expression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Expression.Tokens">
|
||||
<summary>
|
||||
Gets or sets the list of tokens associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)"/> when <see cref="P:Esprima.ParserOptions.Tokens"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Expression.Comments">
|
||||
<summary>
|
||||
Gets or sets the list of comments associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)"/> when <see cref="P:Esprima.ParserOptions.Comments"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ForInStatement.Left">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> (may have an initializer in non-strict mode) | <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ForOfStatement.Left">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> (cannot have an initializer) | <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ForStatement.Init">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> (var i) | <see cref="T:Esprima.Ast.Expression"/> (i=0)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.FunctionDeclaration.Params">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.FunctionExpression.Params">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.IClass">
|
||||
<summary>
|
||||
Represents either a <see cref="T:Esprima.Ast.ClassDeclaration"/> or an <see cref="T:Esprima.Ast.ClassExpression"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.IFunction">
|
||||
<summary>
|
||||
Represents either a <see cref="T:Esprima.Ast.FunctionDeclaration"/>, a <see cref="T:Esprima.Ast.FunctionExpression"/> or an <see cref="T:Esprima.Ast.ArrowFunctionExpression"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.IModuleSpecifier">
|
||||
<summary>
|
||||
Represents either an <see cref="T:Esprima.Ast.ExportSpecifier"/> or an <see cref="T:Esprima.Ast.ImportDeclarationSpecifier"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ImportAttribute.Key">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string or numeric)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ImportSpecifier.Imported">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.Jsx.JsxExpression">
|
||||
<summary>
|
||||
A Jsx expression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.MemberExpression.Computed">
|
||||
<summary>
|
||||
True if an indexer is used and the property to be evaluated.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Ast.Node.GetChildNodes">
|
||||
<remarks>
|
||||
Inheritors who extend the AST with custom node types should override this method and provide an actual implementation.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.Ast.Node.AcceptAsExtension(Esprima.Utils.AstVisitor)">
|
||||
<summary>
|
||||
Dispatches the visitation of the current node to <see cref="M:Esprima.Utils.AstVisitor.VisitExtension(Esprima.Ast.Node)"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
When defining custom node types, inheritors can use this method to implement the abstract <see cref="M:Esprima.Ast.Node.Accept(Esprima.Utils.AstVisitor)"/> method.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.Ast.NodeList`1.#ctor(`0[],System.Int32)">
|
||||
<remarks>
|
||||
Expects ownership of the array!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.NodeList`1.Enumerator">
|
||||
<remarks>
|
||||
This implementation does not detect changes to the list
|
||||
during iteration and therefore the behaviour is undefined
|
||||
under those conditions.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ObjectExpression.Properties">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Property"/> | <see cref="T:Esprima.Ast.SpreadElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ObjectPattern.Properties">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Property"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Program.Tokens">
|
||||
<summary>
|
||||
Gets or sets the list of tokens associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)"/> and <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)"/> when <see cref="P:Esprima.ParserOptions.Tokens"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Program.Comments">
|
||||
<summary>
|
||||
Gets or sets the list of comments associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)"/> and <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)"/> when <see cref="P:Esprima.ParserOptions.Comments"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Property.Key">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string or numeric) | '[' <see cref="T:Esprima.Ast.Expression"/> ']'
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Property.Value">
|
||||
<remarks>
|
||||
When property of an object literal: <see cref="T:Esprima.Ast.Expression"/> (incl. <see cref="T:Esprima.Ast.SpreadElement"/> and <see cref="T:Esprima.Ast.FunctionExpression"/> for getters/setters/methods) <br />
|
||||
When property of an object binding pattern: <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.RestElement.Argument">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.SyntaxElement.AssociatedData">
|
||||
<summary>
|
||||
Gets or sets the arbitrary, user-defined data object associated with the current <see cref="T:Esprima.Ast.SyntaxElement"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.VariableDeclarator.Id">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.CollectingErrorHandler">
|
||||
<summary>
|
||||
Error handler that collects errors that have been seen during the parsing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.ErrorHandler">
|
||||
<summary>
|
||||
Default error handling logic for Esprima.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.EsprimaExceptionHelper">
|
||||
<remarks>
|
||||
JIT cannot inline methods that have <see langword="throw"/> in them. These helper methods allow us to work around this.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.JavaScriptParser">
|
||||
<summary>
|
||||
Provides JavaScript parsing capabilities.
|
||||
</summary>
|
||||
<remarks>
|
||||
Use the <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)" />, <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)" /> or <see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)" /> methods to parse the JavaScript code.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.#ctor">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Esprima.JavaScriptParser" /> instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.#ctor(Esprima.ParserOptions)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Esprima.JavaScriptParser" /> instance.
|
||||
</summary>
|
||||
<param name="options">The parser options.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)">
|
||||
<summary>
|
||||
Parses the code as a JavaScript module.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)">
|
||||
<summary>
|
||||
Parses the code as a JavaScript script.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.GetTokenRaw(Esprima.Token@)">
|
||||
<summary>
|
||||
From internal representation to an external structure
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.Expect(System.String)">
|
||||
<summary>
|
||||
Expect the next token to match the specified punctuator.
|
||||
If not, an exception will be thrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ExpectCommaSeparator">
|
||||
<summary>
|
||||
Quietly expect a comma when in tolerant mode, otherwise delegates to Expect().
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ExpectKeyword(System.String)">
|
||||
<summary>
|
||||
Expect the next token to match the specified keyword.
|
||||
If not, an exception will be thrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.Match(System.String)">
|
||||
<summary>
|
||||
Return true if the next token matches the specified punctuator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ConsumeMatch(System.String)">
|
||||
<summary>
|
||||
Return true if the next token matches the specified punctuator and consumes the next token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.MatchAny(System.Char,System.Char,System.Char,System.Char)">
|
||||
<summary>
|
||||
Return true if the next token matches any of the specified punctuators.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.MatchKeyword(System.String)">
|
||||
<summary>
|
||||
Return true if the next token matches the specified keyword
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Parses the code as a JavaScript expression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.JsxParser">
|
||||
<summary>
|
||||
Provides JSX parsing capabilities.
|
||||
</summary>
|
||||
<remarks>
|
||||
Use the <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)" />, <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)" /> or
|
||||
<see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)" /> methods to parse the JSX code.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.ParseError.Index">
|
||||
<summary>
|
||||
Zero-based index within the parsed code string. (Can be negative if location information is available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParseError.LineNumber">
|
||||
<summary>
|
||||
One-based line number. (Can be zero if location information is not available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParseError.Column">
|
||||
<summary>
|
||||
One-based column index.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserException.Index">
|
||||
<summary>
|
||||
Zero-based index within the parsed code string. (Can be negative if location information is available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserException.LineNumber">
|
||||
<summary>
|
||||
One-based line number. (Can be zero if location information is not available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserException.Column">
|
||||
<summary>
|
||||
One-based column index.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.ParserOptions">
|
||||
<summary>
|
||||
Parser options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.Tokens">
|
||||
<summary>
|
||||
Gets or sets whether the tokens are included in the parsed tree, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.Comments">
|
||||
<summary>
|
||||
Gets or sets whether the comments are included in the parsed tree, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.Tolerant">
|
||||
<summary>
|
||||
Gets or sets whether the parser is tolerant to errors, defaults to <see langword="true"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.AllowReturnOutsideFunction">
|
||||
<summary>
|
||||
Gets or sets whether the parser allows return statement to be used outside of functions, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.ErrorHandler">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:Esprima.ParserOptions.ErrorHandler"/> to use, defaults to <see cref="F:Esprima.ErrorHandler.Default"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.RegExpParseMode">
|
||||
<summary>
|
||||
Gets or sets how regular expressions should be parsed, defaults to <see cref="F:Esprima.RegExpParseMode.AdaptToInterpreted"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.RegexTimeout">
|
||||
<summary>
|
||||
Default timeout for created <see cref="T:System.Text.RegularExpressions.Regex"/> instances, defaults to 10 seconds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.MaxAssignmentDepth">
|
||||
<summary>
|
||||
The maximum depth of assignments allowed, defaults to 200.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.OnNodeCreated">
|
||||
<summary>
|
||||
Action to execute on each parsed node.
|
||||
</summary>
|
||||
<remarks>
|
||||
This callback allows you to make changes to the nodes created by the parser.
|
||||
E.g. you can use it to store a reference to the parent node for later use:
|
||||
<code>
|
||||
options.OnNodeCreated = node =>
|
||||
{
|
||||
foreach (var child in node.ChildNodes)
|
||||
{
|
||||
child.AssociatedData = node;
|
||||
}
|
||||
};
|
||||
</code>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Position">
|
||||
<summary>
|
||||
Represents a source position as line number and column offset, where
|
||||
the first line is 1 and first column is 0.
|
||||
</summary>
|
||||
<remarks>
|
||||
A position where <see cref="F:Esprima.Position.Line"/> and <see cref="F:Esprima.Position.Column"/> are zero
|
||||
is an allowed (and the default) value but considered an invalid
|
||||
position.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.ValidateRegExp(System.String,System.String,Esprima.ParseError@)">
|
||||
<summary>
|
||||
Checks whether an ECMAScript regular expression is syntactically correct.
|
||||
</summary>
|
||||
<remarks>
|
||||
Unicode sets mode (flag v) is not supported currently, for such patterns the method returns <see langword="false"/>.
|
||||
Expressions within Unicode property escape sequences (\p{...} and \P{...}) are not validated (ignored) currently.
|
||||
</remarks>
|
||||
<returns><see langword="true"/> if the regular expression is syntactically correct, otherwise <see langword="false"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.AdaptRegExp(System.String,System.String,System.Boolean,System.Nullable{System.TimeSpan},System.Boolean)">
|
||||
<summary>
|
||||
Parses an ECMAScript regular expression and tries to construct a <see cref="T:System.Text.RegularExpressions.Regex"/> instance with the equivalent behavior.
|
||||
</summary>
|
||||
<remarks>
|
||||
Please note that, because of some fundamental differences between the ECMAScript and .NET regular expression engines,
|
||||
not every ECMAScript regular expression can be converted to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> (or can be converted with compromises only).
|
||||
You can read more about the known issues of the conversion <see href="https://github.com/sebastienros/esprima-dotnet/pull/364#issuecomment-1606045259">here</see>.
|
||||
</remarks>
|
||||
<returns>
|
||||
An instance of <see cref="T:Esprima.RegExpParseResult"/>, whose <see cref="P:Esprima.RegExpParseResult.Regex"/> property contains the equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> if the conversion was possible,
|
||||
otherwise <see langword="null"/> (unless <paramref name="throwIfNotAdaptable"/> is <see langword="true"/>).
|
||||
</returns>
|
||||
<exception cref="T:Esprima.ParserException">
|
||||
<paramref name="pattern"/> is an invalid regular expression pattern or cannot be converted
|
||||
to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> (if <paramref name="throwIfNotAdaptable"/> is <see langword="true"/>).
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.RegExpParser.CheckBracesBalance(Esprima.ArrayList{Esprima.Scanner.RegExpCapturingGroup}@,System.Collections.Generic.Dictionary{System.String,System.String}@)">
|
||||
<summary>
|
||||
Ensures the braces are balanced in the regular expression pattern.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.RegExpParser.ParsePattern``1(``0,Esprima.ArrayList{Esprima.Scanner.RegExpCapturingGroup}@,System.Collections.Generic.Dictionary{System.String,System.String},Esprima.ParseError@)">
|
||||
<summary>
|
||||
Check the regular expression pattern for additional syntax errors and optionally build an adjusted pattern which
|
||||
implements the equivalent behavior in .NET, on top of the <see cref="F:System.Text.RegularExpressions.RegexOptions.ECMAScript"/> compatibility mode.
|
||||
</summary>
|
||||
<returns>
|
||||
<see langword="null"/> if the scanner is configured to validate the regular expression pattern but not adapt it to .NET.
|
||||
Otherwise, the adapted pattern or <see langword="null"/> if the pattern is syntactically correct but a .NET equivalent could not be constructed
|
||||
and the scanner is configured to tolerant mode.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:Esprima.RegExpParseMode">
|
||||
<summary>
|
||||
Specifies how the scanner should parse regular expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.Skip">
|
||||
<summary>
|
||||
Scan regular expressions without checking that they are syntactically correct.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.Validate">
|
||||
<summary>
|
||||
Scan regular expressions and check that they are syntactically correct (throw <see cref="T:Esprima.ParserException"/> if an invalid regular expression is encountered)
|
||||
but don't attempt to convert them to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.AdaptToInterpreted">
|
||||
<summary>
|
||||
Scan regular expressions, check that they are syntactically correct (throw <see cref="T:Esprima.ParserException"/> if an invalid regular expression is encountered)
|
||||
and attempt to convert them to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> without the <see cref="F:System.Text.RegularExpressions.RegexOptions.Compiled"/> option.
|
||||
</summary>
|
||||
<remarks>
|
||||
In the case of a valid regular expression for which an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> cannot be constructed, either <see cref="T:Esprima.ParserException"/> is thrown
|
||||
or a <see cref="T:Esprima.Token"/> is created with the <see cref="P:Esprima.Token.Value"/> property set to <see langword="null"/>, depending on the <see cref="P:Esprima.ScannerOptions.Tolerant"/> option.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.AdaptToCompiled">
|
||||
<summary>
|
||||
Scan regular expressions, check that they are syntactically correct (throw <see cref="T:Esprima.ParserException"/> if an invalid regular expression is encountered)
|
||||
and attempt to convert them to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> with the <see cref="F:System.Text.RegularExpressions.RegexOptions.Compiled"/> option.
|
||||
</summary>
|
||||
<remarks>
|
||||
In the case of a valid regular expression for which an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> cannot be constructed, either <see cref="T:Esprima.ParserException"/> is thrown
|
||||
or a <see cref="T:Esprima.Token"/> is created with the <see cref="P:Esprima.Token.Value"/> property set to <see langword="null"/>, depending on the <see cref="P:Esprima.ScannerOptions.Tolerant"/> option.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.ScannerOptions">
|
||||
<summary>
|
||||
Scanner options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.Comments">
|
||||
<summary>
|
||||
Gets or sets whether the comments are collected, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.Tolerant">
|
||||
<summary>
|
||||
Gets or sets whether the scanner is tolerant to errors, defaults to <see langword="true"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.ErrorHandler">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:Esprima.ScannerOptions.ErrorHandler"/> to use, defaults to <see cref="F:Esprima.ErrorHandler.Default"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.RegExpParseMode">
|
||||
<summary>
|
||||
Gets or sets how regular expressions should be parsed, defaults to <see cref="F:Esprima.RegExpParseMode.AdaptToInterpreted"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.RegexTimeout">
|
||||
<summary>
|
||||
Default timeout for created <see cref="T:System.Text.RegularExpressions.Regex"/> instances, defaults to 10 seconds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.StringPool">
|
||||
<summary>
|
||||
A heavily slimmed down version of <see cref="T:System.Collections.Generic.HashSet`1"/> which can be used to reduce memory allocations when dissecting a string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.Initialize(System.Int32)">
|
||||
<summary>
|
||||
Initializes buckets and slots arrays. Uses suggested capacity by finding next prime
|
||||
greater than or equal to capacity.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.GetBucketRef(System.Int32)">
|
||||
<summary>Gets a reference to the specified hashcode's bucket, containing an index into <see cref="F:Esprima.StringPool._entries"/>.</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.GetOrCreate(System.ReadOnlySpan{System.Char})">
|
||||
<summary>Adds the specified string to the <see cref="T:Esprima.StringPool"/> object if it's not already contained.</summary>
|
||||
<param name="value">The string to add.</param>
|
||||
<returns>The stored string instance.</returns>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.GetHashCode(System.ReadOnlySpan{System.Char})">
|
||||
<summary>
|
||||
Gets the (positive) hashcode for a given <see cref="T:System.ReadOnlySpan`1"/> instance.
|
||||
</summary>
|
||||
<param name="span">The input <see cref="T:System.ReadOnlySpan`1"/> instance.</param>
|
||||
<returns>The hashcode for <paramref name="span"/>.</returns>
|
||||
</member>
|
||||
<member name="F:Esprima.StringPool.Entry.Next">
|
||||
<summary>
|
||||
0-based index of next entry in chain: -1 means end of chain
|
||||
also encodes whether this entry _itself_ is part of the free list by changing sign and subtracting 3,
|
||||
so -2 means end of free list, -3 means index 0 but on free list, -4 means index 1 but on free list, etc.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Utils.AstToJsonOptions.TestCompatibilityMode">
|
||||
<summary>
|
||||
This switch is intended for enabling a compatibility mode for <see cref="T:Esprima.Utils.AstToJsonConverter"/> to build a JSON output
|
||||
which matches the format of the test fixtures of the original Esprima project.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Utils.ExpressionHelper.GetOperatorPrecedence(Esprima.Ast.Expression,System.Int32@)">
|
||||
<summary>
|
||||
Maps operator precedence to an integer value.
|
||||
</summary>
|
||||
<param name="expression">The expression representing the operation.</param>
|
||||
<param name="associativity">
|
||||
If less than zero, the operation has left-to-right associativity.<br/>
|
||||
If zero, associativity is not defined for the operation.<br/>
|
||||
If greater than zero, the operation has right-to-left associativity.
|
||||
</param>
|
||||
<returns>
|
||||
Precedence value as defined based on <see href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_Precedence#table">this table</see>. Higher value means higher precedence.
|
||||
Negative value is returned if the precedence is not defined for the specified expression. <see cref="F:System.Int32.MaxValue"/> is returned for primitive expressions like <see cref="T:Esprima.Ast.Identifier"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.JavaScriptTextFormatter">
|
||||
<summary>
|
||||
Base class for JavaScript code formatters.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.JavaScriptTextWriter">
|
||||
<summary>
|
||||
Base JavaScript text writer (code formatter) which uses the most compact possible (i.e. minimal) format.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TriviaFlags.LeadingNewLineRequired">
|
||||
<summary>
|
||||
A leading new line is required for the current trivia (i.e. it must start in a new line).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TriviaFlags.TrailingNewLineRequired">
|
||||
<summary>
|
||||
A trailing new line is required for the current trivia (i.e. it must be followed by a new line).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TriviaFlags.SurroundingNewLineRequired">
|
||||
<summary>
|
||||
Surrounding new lines are required for the current trivia.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.Leading">
|
||||
<summary>
|
||||
The punctuator precedes the related token(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.InBetween">
|
||||
<summary>
|
||||
The punctuator is somewhere in the middle of the related token(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.Trailing">
|
||||
<summary>
|
||||
The punctuator follows the related token(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.FollowsStatementBody">
|
||||
<summary>
|
||||
The keyword follows the body of a statement and precedes another body of the same statement (e.g. the else branch of an <see cref="T:Esprima.Ast.IfStatement"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.LeadingSpaceRecommended">
|
||||
<summary>
|
||||
A leading space is recommended for the current token (unless other white-space precedes it).
|
||||
</summary>
|
||||
<remarks>
|
||||
May or may not be respected. (It is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.TrailingSpaceRecommended">
|
||||
<summary>
|
||||
A trailing space is recommended for the current token (unless other white-space follows it).
|
||||
</summary>
|
||||
<remarks>
|
||||
May or may not be respected. (It is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.SurroundingSpaceRecommended">
|
||||
<summary>
|
||||
Surrounding spaces are recommended for the current token (unless other white-spaces surround it).
|
||||
</summary>
|
||||
<remarks>
|
||||
May or may not be respected. (It is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.NeedsSemicolon">
|
||||
<summary>
|
||||
The statement must be terminated with a semicolon.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.MayOmitRightMostSemicolon">
|
||||
<summary>
|
||||
If <see cref="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.NeedsSemicolon"/> is set, determines if the semicolon can be omitted when the statement comes last in the current block (see <seealso cref="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.IsRightMost"/>).
|
||||
</summary>
|
||||
<remarks>
|
||||
Automatically propagated to child statements, should be set directly only for statement list items.
|
||||
Whether the semicolon is omitted or not is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.IsRightMost">
|
||||
<summary>
|
||||
The statement comes last in the current statement list (more precisely, it is the right-most part in the textual representation of the current statement list).
|
||||
</summary>
|
||||
<remarks>
|
||||
In the visitation handlers of <see cref="T:Esprima.Utils.AstToJavaScriptConverter"/> the flag is interpreted differently: it indicates that the statement comes last in the parent statement.
|
||||
(Upon visiting a statement, this flag of the parent and child statement gets combined to determine its effective value for the current statement list.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.IsStatementBody">
|
||||
<summary>
|
||||
The statement represents the body of another statement (e.g. the if branch of an <see cref="T:Esprima.Ast.IfStatement"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.ExpressionFlags.NeedsBrackets">
|
||||
<summary>
|
||||
The expression must be wrapped in brackets.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.ExpressionFlags.IsLeftMost">
|
||||
<summary>
|
||||
The expression comes first in the current expression tree, more precisely, it is the left-most part in the textual representation of the currently visited expression tree (incl. brackets).
|
||||
</summary>
|
||||
<remarks>
|
||||
In the visitation handlers of <see cref="T:Esprima.Utils.AstToJavaScriptConverter"/> the flag is interpreted differently: it indicates that the expression comes first in the parent expression.
|
||||
(Upon visiting an expression, this flag of the parent and child expression gets combined to determine its effective value for the expression tree.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Utils.JavaScriptTextWriter.WriteContext.AssociatedData">
|
||||
<summary>
|
||||
Gets or sets the arbitrary, user-defined data object associated with the current <see cref="T:Esprima.Utils.JavaScriptTextWriter.WriteContext"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.JsonTextWriter">
|
||||
<summary>
|
||||
Represents a writer that provides a fast, non-cached, forward-only
|
||||
way of generating streams or files containing JSON Text according
|
||||
to the grammar rules laid out in
|
||||
<a href="http://www.ietf.org/rfc/rfc4627.txt">RFC 4627</a>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Utils.Jsx.JsxAstRewriter.CreateJsxRewriterFor``1(``0)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Esprima.Utils.Jsx.IJsxAstVisitor"/> instance which can be used for working around multiple inheritance:
|
||||
the returned instance re-routes visitations of JSX nodes to the specified <paramref name="rewriter"/>,
|
||||
thus it can be used for emulating base class method calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Utils.Jsx.JsxAstVisitor.CreateJsxVisitorFor``1(``0)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Esprima.Utils.Jsx.IJsxAstVisitor"/> instance which can be used for working around multiple inheritance:
|
||||
the returned instance re-routes visitations of JSX nodes to the specified <paramref name="visitor"/>,
|
||||
thus it can be used for emulating base class method calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.KnRJavaScriptTextFormatter">
|
||||
<summary>
|
||||
JavaScript code formatter which implements the most commonly used <see href="https://en.wikipedia.org/wiki/Indentation_style#K&R_style">K&R style</see>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.HexConverter.CharToHexLookup">
|
||||
<summary>Map from an ASCII char to its hex value, e.g. arr['b'] == 11. 0xFF means it's not a hex digit.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>
|
||||
Applied to a method that will never return under any circumstance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>
|
||||
Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>
|
||||
Initializes the attribute with the specified return value condition.
|
||||
</summary>
|
||||
<param name="returnValue">The return value condition. If the method returns this value, the associated parameter may be null.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>
|
||||
Gets the return value condition.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.IsExternalInit">
|
||||
<summary>
|
||||
Reserved to be used by the compiler for tracking metadata.
|
||||
This class should not be used by developers in source code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.SkipLocalsInitAttribute">
|
||||
<summary>
|
||||
Used to indicate to the compiler that the <c>.locals init</c> flag should not be set in method headers.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,825 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Esprima</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:Esprima.ArrayList`1.#ctor(`0[])">
|
||||
<remarks>
|
||||
Expects ownership of the array!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.ArrayList`1.AsSpan">
|
||||
<remarks>
|
||||
Items should not be added or removed from the <see cref="T:Esprima.ArrayList`1"/> while the returned <see cref="T:System.Span`1"/> is in use!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.ArrayList`1.AsReadOnlySpan">
|
||||
<remarks>
|
||||
Items should not be added or removed from the <see cref="T:Esprima.ArrayList`1"/> while the returned <see cref="T:System.ReadOnlySpan`1"/> is in use!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.ArrayList`1.Enumerator">
|
||||
<remarks>
|
||||
This implementation does not detect changes to the list
|
||||
during iteration and therefore the behaviour is undefined
|
||||
under those conditions.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrayExpression.Elements">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Expression"/> (incl. <see cref="T:Esprima.Ast.SpreadElement"/>) | <see langword="null"/> (omitted element) }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrayPattern.Elements">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> | <see langword="null"/> (omitted element) }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrowFunctionExpression.Params">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrowFunctionExpression.Body">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.BlockStatement"/> | <see cref="T:Esprima.Ast.Expression"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.ArrowParameterPlaceHolder">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.ArrowParameterPlaceHolder"/> nodes never appear in the final AST, only used during its construction.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.AssignmentExpression.Left">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.AssignmentPattern.Left">
|
||||
<summary>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.CatchClause.Param">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ChainExpression.Expression">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.CallExpression"/> | <see cref="T:Esprima.Ast.ComputedMemberExpression"/>| <see cref="T:Esprima.Ast.StaticMemberExpression"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ClassBody.Body">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.MethodDefinition"/> | <see cref="T:Esprima.Ast.PropertyDefinition"/> | <see cref="T:Esprima.Ast.StaticBlock"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ClassProperty.Key">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string or numeric) | '[' <see cref="T:Esprima.Ast.Expression"/> ']' | <see cref="T:Esprima.Ast.PrivateIdentifier"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportAllDeclaration.Exported">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportDefaultDeclaration.Declaration">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Expression"/> | <see cref="T:Esprima.Ast.ClassDeclaration"/> | <see cref="T:Esprima.Ast.FunctionDeclaration"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportNamedDeclaration.Declaration">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> | <see cref="T:Esprima.Ast.ClassDeclaration"/> | <see cref="T:Esprima.Ast.FunctionDeclaration"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportSpecifier.Local">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportSpecifier.Exported">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.Expression">
|
||||
<summary>
|
||||
A JavaScript expression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Expression.Tokens">
|
||||
<summary>
|
||||
Gets or sets the list of tokens associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)"/> when <see cref="P:Esprima.ParserOptions.Tokens"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Expression.Comments">
|
||||
<summary>
|
||||
Gets or sets the list of comments associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)"/> when <see cref="P:Esprima.ParserOptions.Comments"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ForInStatement.Left">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> (may have an initializer in non-strict mode) | <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ForOfStatement.Left">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> (cannot have an initializer) | <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ForStatement.Init">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> (var i) | <see cref="T:Esprima.Ast.Expression"/> (i=0)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.FunctionDeclaration.Params">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.FunctionExpression.Params">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.IClass">
|
||||
<summary>
|
||||
Represents either a <see cref="T:Esprima.Ast.ClassDeclaration"/> or an <see cref="T:Esprima.Ast.ClassExpression"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.IFunction">
|
||||
<summary>
|
||||
Represents either a <see cref="T:Esprima.Ast.FunctionDeclaration"/>, a <see cref="T:Esprima.Ast.FunctionExpression"/> or an <see cref="T:Esprima.Ast.ArrowFunctionExpression"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.IModuleSpecifier">
|
||||
<summary>
|
||||
Represents either an <see cref="T:Esprima.Ast.ExportSpecifier"/> or an <see cref="T:Esprima.Ast.ImportDeclarationSpecifier"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ImportAttribute.Key">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string or numeric)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ImportSpecifier.Imported">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.Jsx.JsxExpression">
|
||||
<summary>
|
||||
A Jsx expression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.MemberExpression.Computed">
|
||||
<summary>
|
||||
True if an indexer is used and the property to be evaluated.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Ast.Node.GetChildNodes">
|
||||
<remarks>
|
||||
Inheritors who extend the AST with custom node types should override this method and provide an actual implementation.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.Ast.Node.AcceptAsExtension(Esprima.Utils.AstVisitor)">
|
||||
<summary>
|
||||
Dispatches the visitation of the current node to <see cref="M:Esprima.Utils.AstVisitor.VisitExtension(Esprima.Ast.Node)"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
When defining custom node types, inheritors can use this method to implement the abstract <see cref="M:Esprima.Ast.Node.Accept(Esprima.Utils.AstVisitor)"/> method.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.Ast.NodeList`1.#ctor(`0[],System.Int32)">
|
||||
<remarks>
|
||||
Expects ownership of the array!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.NodeList`1.Enumerator">
|
||||
<remarks>
|
||||
This implementation does not detect changes to the list
|
||||
during iteration and therefore the behaviour is undefined
|
||||
under those conditions.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ObjectExpression.Properties">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Property"/> | <see cref="T:Esprima.Ast.SpreadElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ObjectPattern.Properties">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Property"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Program.Tokens">
|
||||
<summary>
|
||||
Gets or sets the list of tokens associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)"/> and <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)"/> when <see cref="P:Esprima.ParserOptions.Tokens"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Program.Comments">
|
||||
<summary>
|
||||
Gets or sets the list of comments associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)"/> and <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)"/> when <see cref="P:Esprima.ParserOptions.Comments"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Property.Key">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string or numeric) | '[' <see cref="T:Esprima.Ast.Expression"/> ']'
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Property.Value">
|
||||
<remarks>
|
||||
When property of an object literal: <see cref="T:Esprima.Ast.Expression"/> (incl. <see cref="T:Esprima.Ast.SpreadElement"/> and <see cref="T:Esprima.Ast.FunctionExpression"/> for getters/setters/methods) <br />
|
||||
When property of an object binding pattern: <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.RestElement.Argument">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.SyntaxElement.AssociatedData">
|
||||
<summary>
|
||||
Gets or sets the arbitrary, user-defined data object associated with the current <see cref="T:Esprima.Ast.SyntaxElement"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.VariableDeclarator.Id">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.CollectingErrorHandler">
|
||||
<summary>
|
||||
Error handler that collects errors that have been seen during the parsing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.ErrorHandler">
|
||||
<summary>
|
||||
Default error handling logic for Esprima.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.EsprimaExceptionHelper">
|
||||
<remarks>
|
||||
JIT cannot inline methods that have <see langword="throw"/> in them. These helper methods allow us to work around this.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.JavaScriptParser">
|
||||
<summary>
|
||||
Provides JavaScript parsing capabilities.
|
||||
</summary>
|
||||
<remarks>
|
||||
Use the <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)" />, <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)" /> or <see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)" /> methods to parse the JavaScript code.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.#ctor">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Esprima.JavaScriptParser" /> instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.#ctor(Esprima.ParserOptions)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Esprima.JavaScriptParser" /> instance.
|
||||
</summary>
|
||||
<param name="options">The parser options.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)">
|
||||
<summary>
|
||||
Parses the code as a JavaScript module.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)">
|
||||
<summary>
|
||||
Parses the code as a JavaScript script.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.GetTokenRaw(Esprima.Token@)">
|
||||
<summary>
|
||||
From internal representation to an external structure
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.Expect(System.String)">
|
||||
<summary>
|
||||
Expect the next token to match the specified punctuator.
|
||||
If not, an exception will be thrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ExpectCommaSeparator">
|
||||
<summary>
|
||||
Quietly expect a comma when in tolerant mode, otherwise delegates to Expect().
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ExpectKeyword(System.String)">
|
||||
<summary>
|
||||
Expect the next token to match the specified keyword.
|
||||
If not, an exception will be thrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.Match(System.String)">
|
||||
<summary>
|
||||
Return true if the next token matches the specified punctuator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ConsumeMatch(System.String)">
|
||||
<summary>
|
||||
Return true if the next token matches the specified punctuator and consumes the next token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.MatchAny(System.Char,System.Char,System.Char,System.Char)">
|
||||
<summary>
|
||||
Return true if the next token matches any of the specified punctuators.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.MatchKeyword(System.String)">
|
||||
<summary>
|
||||
Return true if the next token matches the specified keyword
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Parses the code as a JavaScript expression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.JsxParser">
|
||||
<summary>
|
||||
Provides JSX parsing capabilities.
|
||||
</summary>
|
||||
<remarks>
|
||||
Use the <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)" />, <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)" /> or
|
||||
<see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)" /> methods to parse the JSX code.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.ParseError.Index">
|
||||
<summary>
|
||||
Zero-based index within the parsed code string. (Can be negative if location information is available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParseError.LineNumber">
|
||||
<summary>
|
||||
One-based line number. (Can be zero if location information is not available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParseError.Column">
|
||||
<summary>
|
||||
One-based column index.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserException.Index">
|
||||
<summary>
|
||||
Zero-based index within the parsed code string. (Can be negative if location information is available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserException.LineNumber">
|
||||
<summary>
|
||||
One-based line number. (Can be zero if location information is not available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserException.Column">
|
||||
<summary>
|
||||
One-based column index.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.ParserOptions">
|
||||
<summary>
|
||||
Parser options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.Tokens">
|
||||
<summary>
|
||||
Gets or sets whether the tokens are included in the parsed tree, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.Comments">
|
||||
<summary>
|
||||
Gets or sets whether the comments are included in the parsed tree, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.Tolerant">
|
||||
<summary>
|
||||
Gets or sets whether the parser is tolerant to errors, defaults to <see langword="true"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.AllowReturnOutsideFunction">
|
||||
<summary>
|
||||
Gets or sets whether the parser allows return statement to be used outside of functions, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.ErrorHandler">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:Esprima.ParserOptions.ErrorHandler"/> to use, defaults to <see cref="F:Esprima.ErrorHandler.Default"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.RegExpParseMode">
|
||||
<summary>
|
||||
Gets or sets how regular expressions should be parsed, defaults to <see cref="F:Esprima.RegExpParseMode.AdaptToInterpreted"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.RegexTimeout">
|
||||
<summary>
|
||||
Default timeout for created <see cref="T:System.Text.RegularExpressions.Regex"/> instances, defaults to 10 seconds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.MaxAssignmentDepth">
|
||||
<summary>
|
||||
The maximum depth of assignments allowed, defaults to 200.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.OnNodeCreated">
|
||||
<summary>
|
||||
Action to execute on each parsed node.
|
||||
</summary>
|
||||
<remarks>
|
||||
This callback allows you to make changes to the nodes created by the parser.
|
||||
E.g. you can use it to store a reference to the parent node for later use:
|
||||
<code>
|
||||
options.OnNodeCreated = node =>
|
||||
{
|
||||
foreach (var child in node.ChildNodes)
|
||||
{
|
||||
child.AssociatedData = node;
|
||||
}
|
||||
};
|
||||
</code>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Position">
|
||||
<summary>
|
||||
Represents a source position as line number and column offset, where
|
||||
the first line is 1 and first column is 0.
|
||||
</summary>
|
||||
<remarks>
|
||||
A position where <see cref="F:Esprima.Position.Line"/> and <see cref="F:Esprima.Position.Column"/> are zero
|
||||
is an allowed (and the default) value but considered an invalid
|
||||
position.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.ValidateRegExp(System.String,System.String,Esprima.ParseError@)">
|
||||
<summary>
|
||||
Checks whether an ECMAScript regular expression is syntactically correct.
|
||||
</summary>
|
||||
<remarks>
|
||||
Unicode sets mode (flag v) is not supported currently, for such patterns the method returns <see langword="false"/>.
|
||||
Expressions within Unicode property escape sequences (\p{...} and \P{...}) are not validated (ignored) currently.
|
||||
</remarks>
|
||||
<returns><see langword="true"/> if the regular expression is syntactically correct, otherwise <see langword="false"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.AdaptRegExp(System.String,System.String,System.Boolean,System.Nullable{System.TimeSpan},System.Boolean)">
|
||||
<summary>
|
||||
Parses an ECMAScript regular expression and tries to construct a <see cref="T:System.Text.RegularExpressions.Regex"/> instance with the equivalent behavior.
|
||||
</summary>
|
||||
<remarks>
|
||||
Please note that, because of some fundamental differences between the ECMAScript and .NET regular expression engines,
|
||||
not every ECMAScript regular expression can be converted to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> (or can be converted with compromises only).
|
||||
You can read more about the known issues of the conversion <see href="https://github.com/sebastienros/esprima-dotnet/pull/364#issuecomment-1606045259">here</see>.
|
||||
</remarks>
|
||||
<returns>
|
||||
An instance of <see cref="T:Esprima.RegExpParseResult"/>, whose <see cref="P:Esprima.RegExpParseResult.Regex"/> property contains the equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> if the conversion was possible,
|
||||
otherwise <see langword="null"/> (unless <paramref name="throwIfNotAdaptable"/> is <see langword="true"/>).
|
||||
</returns>
|
||||
<exception cref="T:Esprima.ParserException">
|
||||
<paramref name="pattern"/> is an invalid regular expression pattern or cannot be converted
|
||||
to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> (if <paramref name="throwIfNotAdaptable"/> is <see langword="true"/>).
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.RegExpParser.CheckBracesBalance(Esprima.ArrayList{Esprima.Scanner.RegExpCapturingGroup}@,System.Collections.Generic.Dictionary{System.String,System.String}@)">
|
||||
<summary>
|
||||
Ensures the braces are balanced in the regular expression pattern.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.RegExpParser.ParsePattern``1(``0,Esprima.ArrayList{Esprima.Scanner.RegExpCapturingGroup}@,System.Collections.Generic.Dictionary{System.String,System.String},Esprima.ParseError@)">
|
||||
<summary>
|
||||
Check the regular expression pattern for additional syntax errors and optionally build an adjusted pattern which
|
||||
implements the equivalent behavior in .NET, on top of the <see cref="F:System.Text.RegularExpressions.RegexOptions.ECMAScript"/> compatibility mode.
|
||||
</summary>
|
||||
<returns>
|
||||
<see langword="null"/> if the scanner is configured to validate the regular expression pattern but not adapt it to .NET.
|
||||
Otherwise, the adapted pattern or <see langword="null"/> if the pattern is syntactically correct but a .NET equivalent could not be constructed
|
||||
and the scanner is configured to tolerant mode.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:Esprima.RegExpParseMode">
|
||||
<summary>
|
||||
Specifies how the scanner should parse regular expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.Skip">
|
||||
<summary>
|
||||
Scan regular expressions without checking that they are syntactically correct.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.Validate">
|
||||
<summary>
|
||||
Scan regular expressions and check that they are syntactically correct (throw <see cref="T:Esprima.ParserException"/> if an invalid regular expression is encountered)
|
||||
but don't attempt to convert them to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.AdaptToInterpreted">
|
||||
<summary>
|
||||
Scan regular expressions, check that they are syntactically correct (throw <see cref="T:Esprima.ParserException"/> if an invalid regular expression is encountered)
|
||||
and attempt to convert them to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> without the <see cref="F:System.Text.RegularExpressions.RegexOptions.Compiled"/> option.
|
||||
</summary>
|
||||
<remarks>
|
||||
In the case of a valid regular expression for which an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> cannot be constructed, either <see cref="T:Esprima.ParserException"/> is thrown
|
||||
or a <see cref="T:Esprima.Token"/> is created with the <see cref="P:Esprima.Token.Value"/> property set to <see langword="null"/>, depending on the <see cref="P:Esprima.ScannerOptions.Tolerant"/> option.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.AdaptToCompiled">
|
||||
<summary>
|
||||
Scan regular expressions, check that they are syntactically correct (throw <see cref="T:Esprima.ParserException"/> if an invalid regular expression is encountered)
|
||||
and attempt to convert them to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> with the <see cref="F:System.Text.RegularExpressions.RegexOptions.Compiled"/> option.
|
||||
</summary>
|
||||
<remarks>
|
||||
In the case of a valid regular expression for which an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> cannot be constructed, either <see cref="T:Esprima.ParserException"/> is thrown
|
||||
or a <see cref="T:Esprima.Token"/> is created with the <see cref="P:Esprima.Token.Value"/> property set to <see langword="null"/>, depending on the <see cref="P:Esprima.ScannerOptions.Tolerant"/> option.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.ScannerOptions">
|
||||
<summary>
|
||||
Scanner options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.Comments">
|
||||
<summary>
|
||||
Gets or sets whether the comments are collected, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.Tolerant">
|
||||
<summary>
|
||||
Gets or sets whether the scanner is tolerant to errors, defaults to <see langword="true"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.ErrorHandler">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:Esprima.ScannerOptions.ErrorHandler"/> to use, defaults to <see cref="F:Esprima.ErrorHandler.Default"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.RegExpParseMode">
|
||||
<summary>
|
||||
Gets or sets how regular expressions should be parsed, defaults to <see cref="F:Esprima.RegExpParseMode.AdaptToInterpreted"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.RegexTimeout">
|
||||
<summary>
|
||||
Default timeout for created <see cref="T:System.Text.RegularExpressions.Regex"/> instances, defaults to 10 seconds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.StringPool">
|
||||
<summary>
|
||||
A heavily slimmed down version of <see cref="T:System.Collections.Generic.HashSet`1"/> which can be used to reduce memory allocations when dissecting a string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.Initialize(System.Int32)">
|
||||
<summary>
|
||||
Initializes buckets and slots arrays. Uses suggested capacity by finding next prime
|
||||
greater than or equal to capacity.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.GetBucketRef(System.Int32)">
|
||||
<summary>Gets a reference to the specified hashcode's bucket, containing an index into <see cref="F:Esprima.StringPool._entries"/>.</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.GetOrCreate(System.ReadOnlySpan{System.Char})">
|
||||
<summary>Adds the specified string to the <see cref="T:Esprima.StringPool"/> object if it's not already contained.</summary>
|
||||
<param name="value">The string to add.</param>
|
||||
<returns>The stored string instance.</returns>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.GetHashCode(System.ReadOnlySpan{System.Char})">
|
||||
<summary>
|
||||
Gets the (positive) hashcode for a given <see cref="T:System.ReadOnlySpan`1"/> instance.
|
||||
</summary>
|
||||
<param name="span">The input <see cref="T:System.ReadOnlySpan`1"/> instance.</param>
|
||||
<returns>The hashcode for <paramref name="span"/>.</returns>
|
||||
</member>
|
||||
<member name="F:Esprima.StringPool.Entry.Next">
|
||||
<summary>
|
||||
0-based index of next entry in chain: -1 means end of chain
|
||||
also encodes whether this entry _itself_ is part of the free list by changing sign and subtracting 3,
|
||||
so -2 means end of free list, -3 means index 0 but on free list, -4 means index 1 but on free list, etc.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Utils.AstToJsonOptions.TestCompatibilityMode">
|
||||
<summary>
|
||||
This switch is intended for enabling a compatibility mode for <see cref="T:Esprima.Utils.AstToJsonConverter"/> to build a JSON output
|
||||
which matches the format of the test fixtures of the original Esprima project.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Utils.ExpressionHelper.GetOperatorPrecedence(Esprima.Ast.Expression,System.Int32@)">
|
||||
<summary>
|
||||
Maps operator precedence to an integer value.
|
||||
</summary>
|
||||
<param name="expression">The expression representing the operation.</param>
|
||||
<param name="associativity">
|
||||
If less than zero, the operation has left-to-right associativity.<br/>
|
||||
If zero, associativity is not defined for the operation.<br/>
|
||||
If greater than zero, the operation has right-to-left associativity.
|
||||
</param>
|
||||
<returns>
|
||||
Precedence value as defined based on <see href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_Precedence#table">this table</see>. Higher value means higher precedence.
|
||||
Negative value is returned if the precedence is not defined for the specified expression. <see cref="F:System.Int32.MaxValue"/> is returned for primitive expressions like <see cref="T:Esprima.Ast.Identifier"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.JavaScriptTextFormatter">
|
||||
<summary>
|
||||
Base class for JavaScript code formatters.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.JavaScriptTextWriter">
|
||||
<summary>
|
||||
Base JavaScript text writer (code formatter) which uses the most compact possible (i.e. minimal) format.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TriviaFlags.LeadingNewLineRequired">
|
||||
<summary>
|
||||
A leading new line is required for the current trivia (i.e. it must start in a new line).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TriviaFlags.TrailingNewLineRequired">
|
||||
<summary>
|
||||
A trailing new line is required for the current trivia (i.e. it must be followed by a new line).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TriviaFlags.SurroundingNewLineRequired">
|
||||
<summary>
|
||||
Surrounding new lines are required for the current trivia.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.Leading">
|
||||
<summary>
|
||||
The punctuator precedes the related token(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.InBetween">
|
||||
<summary>
|
||||
The punctuator is somewhere in the middle of the related token(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.Trailing">
|
||||
<summary>
|
||||
The punctuator follows the related token(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.FollowsStatementBody">
|
||||
<summary>
|
||||
The keyword follows the body of a statement and precedes another body of the same statement (e.g. the else branch of an <see cref="T:Esprima.Ast.IfStatement"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.LeadingSpaceRecommended">
|
||||
<summary>
|
||||
A leading space is recommended for the current token (unless other white-space precedes it).
|
||||
</summary>
|
||||
<remarks>
|
||||
May or may not be respected. (It is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.TrailingSpaceRecommended">
|
||||
<summary>
|
||||
A trailing space is recommended for the current token (unless other white-space follows it).
|
||||
</summary>
|
||||
<remarks>
|
||||
May or may not be respected. (It is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.SurroundingSpaceRecommended">
|
||||
<summary>
|
||||
Surrounding spaces are recommended for the current token (unless other white-spaces surround it).
|
||||
</summary>
|
||||
<remarks>
|
||||
May or may not be respected. (It is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.NeedsSemicolon">
|
||||
<summary>
|
||||
The statement must be terminated with a semicolon.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.MayOmitRightMostSemicolon">
|
||||
<summary>
|
||||
If <see cref="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.NeedsSemicolon"/> is set, determines if the semicolon can be omitted when the statement comes last in the current block (see <seealso cref="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.IsRightMost"/>).
|
||||
</summary>
|
||||
<remarks>
|
||||
Automatically propagated to child statements, should be set directly only for statement list items.
|
||||
Whether the semicolon is omitted or not is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.IsRightMost">
|
||||
<summary>
|
||||
The statement comes last in the current statement list (more precisely, it is the right-most part in the textual representation of the current statement list).
|
||||
</summary>
|
||||
<remarks>
|
||||
In the visitation handlers of <see cref="T:Esprima.Utils.AstToJavaScriptConverter"/> the flag is interpreted differently: it indicates that the statement comes last in the parent statement.
|
||||
(Upon visiting a statement, this flag of the parent and child statement gets combined to determine its effective value for the current statement list.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.IsStatementBody">
|
||||
<summary>
|
||||
The statement represents the body of another statement (e.g. the if branch of an <see cref="T:Esprima.Ast.IfStatement"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.ExpressionFlags.NeedsBrackets">
|
||||
<summary>
|
||||
The expression must be wrapped in brackets.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.ExpressionFlags.IsLeftMost">
|
||||
<summary>
|
||||
The expression comes first in the current expression tree, more precisely, it is the left-most part in the textual representation of the currently visited expression tree (incl. brackets).
|
||||
</summary>
|
||||
<remarks>
|
||||
In the visitation handlers of <see cref="T:Esprima.Utils.AstToJavaScriptConverter"/> the flag is interpreted differently: it indicates that the expression comes first in the parent expression.
|
||||
(Upon visiting an expression, this flag of the parent and child expression gets combined to determine its effective value for the expression tree.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Utils.JavaScriptTextWriter.WriteContext.AssociatedData">
|
||||
<summary>
|
||||
Gets or sets the arbitrary, user-defined data object associated with the current <see cref="T:Esprima.Utils.JavaScriptTextWriter.WriteContext"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.JsonTextWriter">
|
||||
<summary>
|
||||
Represents a writer that provides a fast, non-cached, forward-only
|
||||
way of generating streams or files containing JSON Text according
|
||||
to the grammar rules laid out in
|
||||
<a href="http://www.ietf.org/rfc/rfc4627.txt">RFC 4627</a>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Utils.Jsx.JsxAstRewriter.CreateJsxRewriterFor``1(``0)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Esprima.Utils.Jsx.IJsxAstVisitor"/> instance which can be used for working around multiple inheritance:
|
||||
the returned instance re-routes visitations of JSX nodes to the specified <paramref name="rewriter"/>,
|
||||
thus it can be used for emulating base class method calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Utils.Jsx.JsxAstVisitor.CreateJsxVisitorFor``1(``0)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Esprima.Utils.Jsx.IJsxAstVisitor"/> instance which can be used for working around multiple inheritance:
|
||||
the returned instance re-routes visitations of JSX nodes to the specified <paramref name="visitor"/>,
|
||||
thus it can be used for emulating base class method calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.KnRJavaScriptTextFormatter">
|
||||
<summary>
|
||||
JavaScript code formatter which implements the most commonly used <see href="https://en.wikipedia.org/wiki/Indentation_style#K&R_style">K&R style</see>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.HexConverter.CharToHexLookup">
|
||||
<summary>Map from an ASCII char to its hex value, e.g. arr['b'] == 11. 0xFF means it's not a hex digit.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>
|
||||
Applied to a method that will never return under any circumstance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>
|
||||
Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>
|
||||
Initializes the attribute with the specified return value condition.
|
||||
</summary>
|
||||
<param name="returnValue">The return value condition. If the method returns this value, the associated parameter may be null.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>
|
||||
Gets the return value condition.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.IsExternalInit">
|
||||
<summary>
|
||||
Reserved to be used by the compiler for tracking metadata.
|
||||
This class should not be used by developers in source code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.SkipLocalsInitAttribute">
|
||||
<summary>
|
||||
Used to indicate to the compiler that the <c>.locals init</c> flag should not be set in method headers.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,804 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Esprima</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:Esprima.ArrayList`1.#ctor(`0[])">
|
||||
<remarks>
|
||||
Expects ownership of the array!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.ArrayList`1.AsSpan">
|
||||
<remarks>
|
||||
Items should not be added or removed from the <see cref="T:Esprima.ArrayList`1"/> while the returned <see cref="T:System.Span`1"/> is in use!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.ArrayList`1.AsReadOnlySpan">
|
||||
<remarks>
|
||||
Items should not be added or removed from the <see cref="T:Esprima.ArrayList`1"/> while the returned <see cref="T:System.ReadOnlySpan`1"/> is in use!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.ArrayList`1.Enumerator">
|
||||
<remarks>
|
||||
This implementation does not detect changes to the list
|
||||
during iteration and therefore the behaviour is undefined
|
||||
under those conditions.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrayExpression.Elements">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Expression"/> (incl. <see cref="T:Esprima.Ast.SpreadElement"/>) | <see langword="null"/> (omitted element) }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrayPattern.Elements">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> | <see langword="null"/> (omitted element) }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrowFunctionExpression.Params">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ArrowFunctionExpression.Body">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.BlockStatement"/> | <see cref="T:Esprima.Ast.Expression"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.ArrowParameterPlaceHolder">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.ArrowParameterPlaceHolder"/> nodes never appear in the final AST, only used during its construction.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.AssignmentExpression.Left">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.AssignmentPattern.Left">
|
||||
<summary>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.CatchClause.Param">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ChainExpression.Expression">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.CallExpression"/> | <see cref="T:Esprima.Ast.ComputedMemberExpression"/>| <see cref="T:Esprima.Ast.StaticMemberExpression"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ClassBody.Body">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.MethodDefinition"/> | <see cref="T:Esprima.Ast.PropertyDefinition"/> | <see cref="T:Esprima.Ast.StaticBlock"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ClassProperty.Key">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string or numeric) | '[' <see cref="T:Esprima.Ast.Expression"/> ']' | <see cref="T:Esprima.Ast.PrivateIdentifier"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportAllDeclaration.Exported">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportDefaultDeclaration.Declaration">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Expression"/> | <see cref="T:Esprima.Ast.ClassDeclaration"/> | <see cref="T:Esprima.Ast.FunctionDeclaration"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportNamedDeclaration.Declaration">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> | <see cref="T:Esprima.Ast.ClassDeclaration"/> | <see cref="T:Esprima.Ast.FunctionDeclaration"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportSpecifier.Local">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ExportSpecifier.Exported">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.Expression">
|
||||
<summary>
|
||||
A JavaScript expression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Expression.Tokens">
|
||||
<summary>
|
||||
Gets or sets the list of tokens associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)"/> when <see cref="P:Esprima.ParserOptions.Tokens"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Expression.Comments">
|
||||
<summary>
|
||||
Gets or sets the list of comments associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)"/> when <see cref="P:Esprima.ParserOptions.Comments"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ForInStatement.Left">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> (may have an initializer in non-strict mode) | <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ForOfStatement.Left">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> (cannot have an initializer) | <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ForStatement.Init">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.VariableDeclaration"/> (var i) | <see cref="T:Esprima.Ast.Expression"/> (i=0)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.FunctionDeclaration.Params">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.FunctionExpression.Params">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.IClass">
|
||||
<summary>
|
||||
Represents either a <see cref="T:Esprima.Ast.ClassDeclaration"/> or an <see cref="T:Esprima.Ast.ClassExpression"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.IFunction">
|
||||
<summary>
|
||||
Represents either a <see cref="T:Esprima.Ast.FunctionDeclaration"/>, a <see cref="T:Esprima.Ast.FunctionExpression"/> or an <see cref="T:Esprima.Ast.ArrowFunctionExpression"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.IModuleSpecifier">
|
||||
<summary>
|
||||
Represents either an <see cref="T:Esprima.Ast.ExportSpecifier"/> or an <see cref="T:Esprima.Ast.ImportDeclarationSpecifier"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ImportAttribute.Key">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string or numeric)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ImportSpecifier.Imported">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.Jsx.JsxExpression">
|
||||
<summary>
|
||||
A Jsx expression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.MemberExpression.Computed">
|
||||
<summary>
|
||||
True if an indexer is used and the property to be evaluated.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Ast.Node.GetChildNodes">
|
||||
<remarks>
|
||||
Inheritors who extend the AST with custom node types should override this method and provide an actual implementation.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.Ast.Node.AcceptAsExtension(Esprima.Utils.AstVisitor)">
|
||||
<summary>
|
||||
Dispatches the visitation of the current node to <see cref="M:Esprima.Utils.AstVisitor.VisitExtension(Esprima.Ast.Node)"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
When defining custom node types, inheritors can use this method to implement the abstract <see cref="M:Esprima.Ast.Node.Accept(Esprima.Utils.AstVisitor)"/> method.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.Ast.NodeList`1.#ctor(`0[],System.Int32)">
|
||||
<remarks>
|
||||
Expects ownership of the array!
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Ast.NodeList`1.Enumerator">
|
||||
<remarks>
|
||||
This implementation does not detect changes to the list
|
||||
during iteration and therefore the behaviour is undefined
|
||||
under those conditions.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ObjectExpression.Properties">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Property"/> | <see cref="T:Esprima.Ast.SpreadElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.ObjectPattern.Properties">
|
||||
<summary>
|
||||
{ <see cref="T:Esprima.Ast.Property"/> | <see cref="T:Esprima.Ast.RestElement"/> }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Program.Tokens">
|
||||
<summary>
|
||||
Gets or sets the list of tokens associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)"/> and <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)"/> when <see cref="P:Esprima.ParserOptions.Tokens"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Program.Comments">
|
||||
<summary>
|
||||
Gets or sets the list of comments associated with the AST represented by this node.
|
||||
This property is automatically set by <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)"/> and <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)"/> when <see cref="P:Esprima.ParserOptions.Comments"/> is set to <see langword="true"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Property.Key">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.Literal"/> (string or numeric) | '[' <see cref="T:Esprima.Ast.Expression"/> ']'
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.Property.Value">
|
||||
<remarks>
|
||||
When property of an object literal: <see cref="T:Esprima.Ast.Expression"/> (incl. <see cref="T:Esprima.Ast.SpreadElement"/> and <see cref="T:Esprima.Ast.FunctionExpression"/> for getters/setters/methods) <br />
|
||||
When property of an object binding pattern: <see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/> | <see cref="T:Esprima.Ast.AssignmentPattern"/> | <see cref="T:Esprima.Ast.RestElement"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.RestElement.Argument">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.MemberExpression"/> (in assignment contexts only) | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.SyntaxElement.AssociatedData">
|
||||
<summary>
|
||||
Gets or sets the arbitrary, user-defined data object associated with the current <see cref="T:Esprima.Ast.SyntaxElement"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Ast.VariableDeclarator.Id">
|
||||
<remarks>
|
||||
<see cref="T:Esprima.Ast.Identifier"/> | <see cref="T:Esprima.Ast.BindingPattern"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.CollectingErrorHandler">
|
||||
<summary>
|
||||
Error handler that collects errors that have been seen during the parsing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.ErrorHandler">
|
||||
<summary>
|
||||
Default error handling logic for Esprima.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.EsprimaExceptionHelper">
|
||||
<remarks>
|
||||
JIT cannot inline methods that have <see langword="throw"/> in them. These helper methods allow us to work around this.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.JavaScriptParser">
|
||||
<summary>
|
||||
Provides JavaScript parsing capabilities.
|
||||
</summary>
|
||||
<remarks>
|
||||
Use the <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)" />, <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)" /> or <see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)" /> methods to parse the JavaScript code.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.#ctor">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Esprima.JavaScriptParser" /> instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.#ctor(Esprima.ParserOptions)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Esprima.JavaScriptParser" /> instance.
|
||||
</summary>
|
||||
<param name="options">The parser options.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)">
|
||||
<summary>
|
||||
Parses the code as a JavaScript module.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)">
|
||||
<summary>
|
||||
Parses the code as a JavaScript script.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.GetTokenRaw(Esprima.Token@)">
|
||||
<summary>
|
||||
From internal representation to an external structure
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.Expect(System.String)">
|
||||
<summary>
|
||||
Expect the next token to match the specified punctuator.
|
||||
If not, an exception will be thrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ExpectCommaSeparator">
|
||||
<summary>
|
||||
Quietly expect a comma when in tolerant mode, otherwise delegates to Expect().
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ExpectKeyword(System.String)">
|
||||
<summary>
|
||||
Expect the next token to match the specified keyword.
|
||||
If not, an exception will be thrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.Match(System.String)">
|
||||
<summary>
|
||||
Return true if the next token matches the specified punctuator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ConsumeMatch(System.String)">
|
||||
<summary>
|
||||
Return true if the next token matches the specified punctuator and consumes the next token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.MatchAny(System.Char,System.Char,System.Char,System.Char)">
|
||||
<summary>
|
||||
Return true if the next token matches any of the specified punctuators.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.MatchKeyword(System.String)">
|
||||
<summary>
|
||||
Return true if the next token matches the specified keyword
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Parses the code as a JavaScript expression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.JsxParser">
|
||||
<summary>
|
||||
Provides JSX parsing capabilities.
|
||||
</summary>
|
||||
<remarks>
|
||||
Use the <see cref="M:Esprima.JavaScriptParser.ParseScript(System.String,System.String,System.Boolean)" />, <see cref="M:Esprima.JavaScriptParser.ParseModule(System.String,System.String)" /> or
|
||||
<see cref="M:Esprima.JavaScriptParser.ParseExpression(System.String,System.Boolean)" /> methods to parse the JSX code.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.ParseError.Index">
|
||||
<summary>
|
||||
Zero-based index within the parsed code string. (Can be negative if location information is available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParseError.LineNumber">
|
||||
<summary>
|
||||
One-based line number. (Can be zero if location information is not available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParseError.Column">
|
||||
<summary>
|
||||
One-based column index.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserException.Index">
|
||||
<summary>
|
||||
Zero-based index within the parsed code string. (Can be negative if location information is available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserException.LineNumber">
|
||||
<summary>
|
||||
One-based line number. (Can be zero if location information is not available.)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserException.Column">
|
||||
<summary>
|
||||
One-based column index.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.ParserOptions">
|
||||
<summary>
|
||||
Parser options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.Tokens">
|
||||
<summary>
|
||||
Gets or sets whether the tokens are included in the parsed tree, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.Comments">
|
||||
<summary>
|
||||
Gets or sets whether the comments are included in the parsed tree, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.Tolerant">
|
||||
<summary>
|
||||
Gets or sets whether the parser is tolerant to errors, defaults to <see langword="true"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.AllowReturnOutsideFunction">
|
||||
<summary>
|
||||
Gets or sets whether the parser allows return statement to be used outside of functions, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.ErrorHandler">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:Esprima.ParserOptions.ErrorHandler"/> to use, defaults to <see cref="F:Esprima.ErrorHandler.Default"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.RegExpParseMode">
|
||||
<summary>
|
||||
Gets or sets how regular expressions should be parsed, defaults to <see cref="F:Esprima.RegExpParseMode.AdaptToInterpreted"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.RegexTimeout">
|
||||
<summary>
|
||||
Default timeout for created <see cref="T:System.Text.RegularExpressions.Regex"/> instances, defaults to 10 seconds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.MaxAssignmentDepth">
|
||||
<summary>
|
||||
The maximum depth of assignments allowed, defaults to 200.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ParserOptions.OnNodeCreated">
|
||||
<summary>
|
||||
Action to execute on each parsed node.
|
||||
</summary>
|
||||
<remarks>
|
||||
This callback allows you to make changes to the nodes created by the parser.
|
||||
E.g. you can use it to store a reference to the parent node for later use:
|
||||
<code>
|
||||
options.OnNodeCreated = node =>
|
||||
{
|
||||
foreach (var child in node.ChildNodes)
|
||||
{
|
||||
child.AssociatedData = node;
|
||||
}
|
||||
};
|
||||
</code>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Position">
|
||||
<summary>
|
||||
Represents a source position as line number and column offset, where
|
||||
the first line is 1 and first column is 0.
|
||||
</summary>
|
||||
<remarks>
|
||||
A position where <see cref="F:Esprima.Position.Line"/> and <see cref="F:Esprima.Position.Column"/> are zero
|
||||
is an allowed (and the default) value but considered an invalid
|
||||
position.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.ValidateRegExp(System.String,System.String,Esprima.ParseError@)">
|
||||
<summary>
|
||||
Checks whether an ECMAScript regular expression is syntactically correct.
|
||||
</summary>
|
||||
<remarks>
|
||||
Unicode sets mode (flag v) is not supported currently, for such patterns the method returns <see langword="false"/>.
|
||||
Expressions within Unicode property escape sequences (\p{...} and \P{...}) are not validated (ignored) currently.
|
||||
</remarks>
|
||||
<returns><see langword="true"/> if the regular expression is syntactically correct, otherwise <see langword="false"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.AdaptRegExp(System.String,System.String,System.Boolean,System.Nullable{System.TimeSpan},System.Boolean)">
|
||||
<summary>
|
||||
Parses an ECMAScript regular expression and tries to construct a <see cref="T:System.Text.RegularExpressions.Regex"/> instance with the equivalent behavior.
|
||||
</summary>
|
||||
<remarks>
|
||||
Please note that, because of some fundamental differences between the ECMAScript and .NET regular expression engines,
|
||||
not every ECMAScript regular expression can be converted to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> (or can be converted with compromises only).
|
||||
You can read more about the known issues of the conversion <see href="https://github.com/sebastienros/esprima-dotnet/pull/364#issuecomment-1606045259">here</see>.
|
||||
</remarks>
|
||||
<returns>
|
||||
An instance of <see cref="T:Esprima.RegExpParseResult"/>, whose <see cref="P:Esprima.RegExpParseResult.Regex"/> property contains the equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> if the conversion was possible,
|
||||
otherwise <see langword="null"/> (unless <paramref name="throwIfNotAdaptable"/> is <see langword="true"/>).
|
||||
</returns>
|
||||
<exception cref="T:Esprima.ParserException">
|
||||
<paramref name="pattern"/> is an invalid regular expression pattern or cannot be converted
|
||||
to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> (if <paramref name="throwIfNotAdaptable"/> is <see langword="true"/>).
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.RegExpParser.CheckBracesBalance(Esprima.ArrayList{Esprima.Scanner.RegExpCapturingGroup}@,System.Collections.Generic.Dictionary{System.String,System.String}@)">
|
||||
<summary>
|
||||
Ensures the braces are balanced in the regular expression pattern.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Scanner.RegExpParser.ParsePattern``1(``0,Esprima.ArrayList{Esprima.Scanner.RegExpCapturingGroup}@,System.Collections.Generic.Dictionary{System.String,System.String},Esprima.ParseError@)">
|
||||
<summary>
|
||||
Check the regular expression pattern for additional syntax errors and optionally build an adjusted pattern which
|
||||
implements the equivalent behavior in .NET, on top of the <see cref="F:System.Text.RegularExpressions.RegexOptions.ECMAScript"/> compatibility mode.
|
||||
</summary>
|
||||
<returns>
|
||||
<see langword="null"/> if the scanner is configured to validate the regular expression pattern but not adapt it to .NET.
|
||||
Otherwise, the adapted pattern or <see langword="null"/> if the pattern is syntactically correct but a .NET equivalent could not be constructed
|
||||
and the scanner is configured to tolerant mode.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:Esprima.RegExpParseMode">
|
||||
<summary>
|
||||
Specifies how the scanner should parse regular expressions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.Skip">
|
||||
<summary>
|
||||
Scan regular expressions without checking that they are syntactically correct.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.Validate">
|
||||
<summary>
|
||||
Scan regular expressions and check that they are syntactically correct (throw <see cref="T:Esprima.ParserException"/> if an invalid regular expression is encountered)
|
||||
but don't attempt to convert them to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.AdaptToInterpreted">
|
||||
<summary>
|
||||
Scan regular expressions, check that they are syntactically correct (throw <see cref="T:Esprima.ParserException"/> if an invalid regular expression is encountered)
|
||||
and attempt to convert them to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> without the <see cref="F:System.Text.RegularExpressions.RegexOptions.Compiled"/> option.
|
||||
</summary>
|
||||
<remarks>
|
||||
In the case of a valid regular expression for which an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> cannot be constructed, either <see cref="T:Esprima.ParserException"/> is thrown
|
||||
or a <see cref="T:Esprima.Token"/> is created with the <see cref="P:Esprima.Token.Value"/> property set to <see langword="null"/>, depending on the <see cref="P:Esprima.ScannerOptions.Tolerant"/> option.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.RegExpParseMode.AdaptToCompiled">
|
||||
<summary>
|
||||
Scan regular expressions, check that they are syntactically correct (throw <see cref="T:Esprima.ParserException"/> if an invalid regular expression is encountered)
|
||||
and attempt to convert them to an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> with the <see cref="F:System.Text.RegularExpressions.RegexOptions.Compiled"/> option.
|
||||
</summary>
|
||||
<remarks>
|
||||
In the case of a valid regular expression for which an equivalent <see cref="T:System.Text.RegularExpressions.Regex"/> cannot be constructed, either <see cref="T:Esprima.ParserException"/> is thrown
|
||||
or a <see cref="T:Esprima.Token"/> is created with the <see cref="P:Esprima.Token.Value"/> property set to <see langword="null"/>, depending on the <see cref="P:Esprima.ScannerOptions.Tolerant"/> option.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.ScannerOptions">
|
||||
<summary>
|
||||
Scanner options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.Comments">
|
||||
<summary>
|
||||
Gets or sets whether the comments are collected, defaults to <see langword="false"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.Tolerant">
|
||||
<summary>
|
||||
Gets or sets whether the scanner is tolerant to errors, defaults to <see langword="true"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.ErrorHandler">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:Esprima.ScannerOptions.ErrorHandler"/> to use, defaults to <see cref="F:Esprima.ErrorHandler.Default"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.RegExpParseMode">
|
||||
<summary>
|
||||
Gets or sets how regular expressions should be parsed, defaults to <see cref="F:Esprima.RegExpParseMode.AdaptToInterpreted"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.ScannerOptions.RegexTimeout">
|
||||
<summary>
|
||||
Default timeout for created <see cref="T:System.Text.RegularExpressions.Regex"/> instances, defaults to 10 seconds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.StringPool">
|
||||
<summary>
|
||||
A heavily slimmed down version of <see cref="T:System.Collections.Generic.HashSet`1"/> which can be used to reduce memory allocations when dissecting a string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.Initialize(System.Int32)">
|
||||
<summary>
|
||||
Initializes buckets and slots arrays. Uses suggested capacity by finding next prime
|
||||
greater than or equal to capacity.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.GetBucketRef(System.Int32)">
|
||||
<summary>Gets a reference to the specified hashcode's bucket, containing an index into <see cref="F:Esprima.StringPool._entries"/>.</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.GetOrCreate(System.ReadOnlySpan{System.Char})">
|
||||
<summary>Adds the specified string to the <see cref="T:Esprima.StringPool"/> object if it's not already contained.</summary>
|
||||
<param name="value">The string to add.</param>
|
||||
<returns>The stored string instance.</returns>
|
||||
</member>
|
||||
<member name="M:Esprima.StringPool.GetHashCode(System.ReadOnlySpan{System.Char})">
|
||||
<summary>
|
||||
Gets the (positive) hashcode for a given <see cref="T:System.ReadOnlySpan`1"/> instance.
|
||||
</summary>
|
||||
<param name="span">The input <see cref="T:System.ReadOnlySpan`1"/> instance.</param>
|
||||
<returns>The hashcode for <paramref name="span"/>.</returns>
|
||||
</member>
|
||||
<member name="F:Esprima.StringPool.Entry.Next">
|
||||
<summary>
|
||||
0-based index of next entry in chain: -1 means end of chain
|
||||
also encodes whether this entry _itself_ is part of the free list by changing sign and subtracting 3,
|
||||
so -2 means end of free list, -3 means index 0 but on free list, -4 means index 1 but on free list, etc.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Esprima.Utils.AstToJsonOptions.TestCompatibilityMode">
|
||||
<summary>
|
||||
This switch is intended for enabling a compatibility mode for <see cref="T:Esprima.Utils.AstToJsonConverter"/> to build a JSON output
|
||||
which matches the format of the test fixtures of the original Esprima project.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Utils.ExpressionHelper.GetOperatorPrecedence(Esprima.Ast.Expression,System.Int32@)">
|
||||
<summary>
|
||||
Maps operator precedence to an integer value.
|
||||
</summary>
|
||||
<param name="expression">The expression representing the operation.</param>
|
||||
<param name="associativity">
|
||||
If less than zero, the operation has left-to-right associativity.<br/>
|
||||
If zero, associativity is not defined for the operation.<br/>
|
||||
If greater than zero, the operation has right-to-left associativity.
|
||||
</param>
|
||||
<returns>
|
||||
Precedence value as defined based on <see href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_Precedence#table">this table</see>. Higher value means higher precedence.
|
||||
Negative value is returned if the precedence is not defined for the specified expression. <see cref="F:System.Int32.MaxValue"/> is returned for primitive expressions like <see cref="T:Esprima.Ast.Identifier"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.JavaScriptTextFormatter">
|
||||
<summary>
|
||||
Base class for JavaScript code formatters.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.JavaScriptTextWriter">
|
||||
<summary>
|
||||
Base JavaScript text writer (code formatter) which uses the most compact possible (i.e. minimal) format.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TriviaFlags.LeadingNewLineRequired">
|
||||
<summary>
|
||||
A leading new line is required for the current trivia (i.e. it must start in a new line).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TriviaFlags.TrailingNewLineRequired">
|
||||
<summary>
|
||||
A trailing new line is required for the current trivia (i.e. it must be followed by a new line).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TriviaFlags.SurroundingNewLineRequired">
|
||||
<summary>
|
||||
Surrounding new lines are required for the current trivia.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.Leading">
|
||||
<summary>
|
||||
The punctuator precedes the related token(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.InBetween">
|
||||
<summary>
|
||||
The punctuator is somewhere in the middle of the related token(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.Trailing">
|
||||
<summary>
|
||||
The punctuator follows the related token(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.FollowsStatementBody">
|
||||
<summary>
|
||||
The keyword follows the body of a statement and precedes another body of the same statement (e.g. the else branch of an <see cref="T:Esprima.Ast.IfStatement"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.LeadingSpaceRecommended">
|
||||
<summary>
|
||||
A leading space is recommended for the current token (unless other white-space precedes it).
|
||||
</summary>
|
||||
<remarks>
|
||||
May or may not be respected. (It is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.TrailingSpaceRecommended">
|
||||
<summary>
|
||||
A trailing space is recommended for the current token (unless other white-space follows it).
|
||||
</summary>
|
||||
<remarks>
|
||||
May or may not be respected. (It is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.TokenFlags.SurroundingSpaceRecommended">
|
||||
<summary>
|
||||
Surrounding spaces are recommended for the current token (unless other white-spaces surround it).
|
||||
</summary>
|
||||
<remarks>
|
||||
May or may not be respected. (It is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.NeedsSemicolon">
|
||||
<summary>
|
||||
The statement must be terminated with a semicolon.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.MayOmitRightMostSemicolon">
|
||||
<summary>
|
||||
If <see cref="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.NeedsSemicolon"/> is set, determines if the semicolon can be omitted when the statement comes last in the current block (see <seealso cref="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.IsRightMost"/>).
|
||||
</summary>
|
||||
<remarks>
|
||||
Automatically propagated to child statements, should be set directly only for statement list items.
|
||||
Whether the semicolon is omitted or not is decided by the actual <see cref="T:Esprima.Utils.JavaScriptTextWriter"/> implementation.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.IsRightMost">
|
||||
<summary>
|
||||
The statement comes last in the current statement list (more precisely, it is the right-most part in the textual representation of the current statement list).
|
||||
</summary>
|
||||
<remarks>
|
||||
In the visitation handlers of <see cref="T:Esprima.Utils.AstToJavaScriptConverter"/> the flag is interpreted differently: it indicates that the statement comes last in the parent statement.
|
||||
(Upon visiting a statement, this flag of the parent and child statement gets combined to determine its effective value for the current statement list.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.StatementFlags.IsStatementBody">
|
||||
<summary>
|
||||
The statement represents the body of another statement (e.g. the if branch of an <see cref="T:Esprima.Ast.IfStatement"/>).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.ExpressionFlags.NeedsBrackets">
|
||||
<summary>
|
||||
The expression must be wrapped in brackets.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Esprima.Utils.JavaScriptTextWriter.ExpressionFlags.IsLeftMost">
|
||||
<summary>
|
||||
The expression comes first in the current expression tree, more precisely, it is the left-most part in the textual representation of the currently visited expression tree (incl. brackets).
|
||||
</summary>
|
||||
<remarks>
|
||||
In the visitation handlers of <see cref="T:Esprima.Utils.AstToJavaScriptConverter"/> the flag is interpreted differently: it indicates that the expression comes first in the parent expression.
|
||||
(Upon visiting an expression, this flag of the parent and child expression gets combined to determine its effective value for the expression tree.)
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Esprima.Utils.JavaScriptTextWriter.WriteContext.AssociatedData">
|
||||
<summary>
|
||||
Gets or sets the arbitrary, user-defined data object associated with the current <see cref="T:Esprima.Utils.JavaScriptTextWriter.WriteContext"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The operation is not guaranteed to be thread-safe. In case concurrent access or update is possible, the necessary synchronization is caller's responsibility.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.JsonTextWriter">
|
||||
<summary>
|
||||
Represents a writer that provides a fast, non-cached, forward-only
|
||||
way of generating streams or files containing JSON Text according
|
||||
to the grammar rules laid out in
|
||||
<a href="http://www.ietf.org/rfc/rfc4627.txt">RFC 4627</a>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Utils.Jsx.JsxAstRewriter.CreateJsxRewriterFor``1(``0)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Esprima.Utils.Jsx.IJsxAstVisitor"/> instance which can be used for working around multiple inheritance:
|
||||
the returned instance re-routes visitations of JSX nodes to the specified <paramref name="rewriter"/>,
|
||||
thus it can be used for emulating base class method calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Esprima.Utils.Jsx.JsxAstVisitor.CreateJsxVisitorFor``1(``0)">
|
||||
<summary>
|
||||
Creates an <see cref="T:Esprima.Utils.Jsx.IJsxAstVisitor"/> instance which can be used for working around multiple inheritance:
|
||||
the returned instance re-routes visitations of JSX nodes to the specified <paramref name="visitor"/>,
|
||||
thus it can be used for emulating base class method calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Esprima.Utils.KnRJavaScriptTextFormatter">
|
||||
<summary>
|
||||
JavaScript code formatter which implements the most commonly used <see href="https://en.wikipedia.org/wiki/Indentation_style#K&R_style">K&R style</see>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.HexConverter.CharToHexLookup">
|
||||
<summary>Map from an ASCII char to its hex value, e.g. arr['b'] == 11. 0xFF means it's not a hex digit.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.IsExternalInit">
|
||||
<summary>
|
||||
Reserved to be used by the compiler for tracking metadata.
|
||||
This class should not be used by developers in source code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.SkipLocalsInitAttribute">
|
||||
<summary>
|
||||
Used to indicate to the compiler that the <c>.locals init</c> flag should not be set in method headers.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "kKSyoVfndMriKHLfYGmr0uzQuI4jcc3TKGyww7buJFCYeHb/X0kodYBPL7n9454q7v6ASiRmDgpPGaDGerg/Hg==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
Binary file not shown.
@@ -1,31 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>JetBrains.Annotations</id>
|
||||
<version>2021.2.0</version>
|
||||
<title>JetBrains ReSharper Annotations</title>
|
||||
<authors>JetBrains</authors>
|
||||
<owners>JetBrains</owners>
|
||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>icon.png</icon>
|
||||
<projectUrl>https://www.jetbrains.com/help/resharper/Code_Analysis__Code_Annotations.html</projectUrl>
|
||||
<iconUrl>https://resources.jetbrains.com/storage/products/resharper/img/meta/ReSharper_64.png</iconUrl>
|
||||
<description>ReSharper Annotations help reduce false positive warnings, explicitly declare purity and nullability in your code, deal with implicit usages of members, support special semantics of APIs in ASP.NET and XAML frameworks and otherwise increase accuracy of ReSharper code inspections.
|
||||
|
||||
All usages of ReSharper Annotations attributes are erased from metadata by default, which means no actual binary reference to 'JetBrains.Annotations.dll' assembly is produced. If you need to preserve these attributes in metadata, just define 'JETBRAINS_ANNOTATIONS' conditional compilation symbol in your projects.</description>
|
||||
<summary>Annotations to increase accuracy of ReSharper code inspections</summary>
|
||||
<releaseNotes>• Added 'UriStringAttribute' to enable URL features on string literals
|
||||
• Added 'RequireStaticDelegateAttribute' to enforce the allocation-less usage patterns</releaseNotes>
|
||||
<tags>jetbrains resharper annotations canbenull notnull</tags>
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework2.0" />
|
||||
<group targetFramework=".NETPortable4.0-Profile328" />
|
||||
<group targetFramework=".NETStandard1.0">
|
||||
<dependency id="System.Runtime" version="4.1.0" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 4.4 KiB |
Binary file not shown.
@@ -1 +0,0 @@
|
||||
5PHop6aJCyEWoqW0SDNG4b3QrHsw1ntcAmuFlsUVCoaGi7LT6soi0OIugNvP7u2udV7BwpJYyIlaz8P5cQUXxQ==
|
||||
@@ -1,823 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>JetBrains.Annotations</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:JetBrains.Annotations.CanBeNullAttribute">
|
||||
<summary>
|
||||
Indicates that the value of the marked element could be <c>null</c> sometimes,
|
||||
so checking for <c>null</c> is required before its usage.
|
||||
</summary>
|
||||
<example><code>
|
||||
[CanBeNull] object Test() => null;
|
||||
|
||||
void UseTest() {
|
||||
var p = Test();
|
||||
var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NotNullAttribute">
|
||||
<summary>
|
||||
Indicates that the value of the marked element can never be <c>null</c>.
|
||||
</summary>
|
||||
<example><code>
|
||||
[NotNull] object Foo() {
|
||||
return null; // Warning: Possible 'null' assignment
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ItemNotNullAttribute">
|
||||
<summary>
|
||||
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
|
||||
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
|
||||
or of the Lazy.Value property can never be null.
|
||||
</summary>
|
||||
<example><code>
|
||||
public void Foo([ItemNotNull]List<string> books)
|
||||
{
|
||||
foreach (var book in books) {
|
||||
if (book != null) // Warning: Expression is always true
|
||||
Console.WriteLine(book.ToUpper());
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ItemCanBeNullAttribute">
|
||||
<summary>
|
||||
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
|
||||
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
|
||||
or of the Lazy.Value property can be null.
|
||||
</summary>
|
||||
<example><code>
|
||||
public void Foo([ItemCanBeNull]List<string> books)
|
||||
{
|
||||
foreach (var book in books)
|
||||
{
|
||||
// Warning: Possible 'System.NullReferenceException'
|
||||
Console.WriteLine(book.ToUpper());
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.StringFormatMethodAttribute">
|
||||
<summary>
|
||||
Indicates that the marked method builds string by the format pattern and (optional) arguments.
|
||||
The parameter, which contains the format string, should be given in the constructor. The format string
|
||||
should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>-like form.
|
||||
</summary>
|
||||
<example><code>
|
||||
[StringFormatMethod("message")]
|
||||
void ShowError(string message, params object[] args) { /* do something */ }
|
||||
|
||||
void Foo() {
|
||||
ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="M:JetBrains.Annotations.StringFormatMethodAttribute.#ctor(System.String)">
|
||||
<param name="formatParameterName">
|
||||
Specifies which parameter of an annotated method should be treated as the format string
|
||||
</param>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.StructuredMessageTemplateAttribute">
|
||||
<summary>
|
||||
Indicates that the marked parameter is a message template where placeholders are to be replaced by the following arguments
|
||||
in the order in which they appear
|
||||
</summary>
|
||||
<example><code>
|
||||
void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ }
|
||||
|
||||
void Foo() {
|
||||
LogInfo("User created: {username}"); // Warning: Non-existing argument in format string
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ValueProviderAttribute">
|
||||
<summary>
|
||||
Use this annotation to specify a type that contains static or const fields
|
||||
with values for the annotated property/field/parameter.
|
||||
The specified type will be used to improve completion suggestions.
|
||||
</summary>
|
||||
<example><code>
|
||||
namespace TestNamespace
|
||||
{
|
||||
public class Constants
|
||||
{
|
||||
public static int INT_CONST = 1;
|
||||
public const string STRING_CONST = "1";
|
||||
}
|
||||
|
||||
public class Class1
|
||||
{
|
||||
[ValueProvider("TestNamespace.Constants")] public int myField;
|
||||
public void Foo([ValueProvider("TestNamespace.Constants")] string str) { }
|
||||
|
||||
public void Test()
|
||||
{
|
||||
Foo(/*try completion here*/);//
|
||||
myField = /*try completion here*/
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ValueRangeAttribute">
|
||||
<summary>
|
||||
Indicates that the integral value falls into the specified interval.
|
||||
It's allowed to specify multiple non-intersecting intervals.
|
||||
Values of interval boundaries are inclusive.
|
||||
</summary>
|
||||
<example><code>
|
||||
void Foo([ValueRange(0, 100)] int value) {
|
||||
if (value == -1) { // Warning: Expression is always 'false'
|
||||
...
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NonNegativeValueAttribute">
|
||||
<summary>
|
||||
Indicates that the integral value never falls below zero.
|
||||
</summary>
|
||||
<example><code>
|
||||
void Foo([NonNegativeValue] int value) {
|
||||
if (value == -1) { // Warning: Expression is always 'false'
|
||||
...
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.InvokerParameterNameAttribute">
|
||||
<summary>
|
||||
Indicates that the function argument should be a string literal and match one
|
||||
of the parameters of the caller function. For example, ReSharper annotates
|
||||
the parameter of <see cref="T:System.ArgumentNullException"/>.
|
||||
</summary>
|
||||
<example><code>
|
||||
void Foo(string param) {
|
||||
if (param == null)
|
||||
throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NotifyPropertyChangedInvocatorAttribute">
|
||||
<summary>
|
||||
Indicates that the method is contained in a type that implements
|
||||
<c>System.ComponentModel.INotifyPropertyChanged</c> interface and this method
|
||||
is used to notify that some property value changed.
|
||||
</summary>
|
||||
<remarks>
|
||||
The method should be non-static and conform to one of the supported signatures:
|
||||
<list>
|
||||
<item><c>NotifyChanged(string)</c></item>
|
||||
<item><c>NotifyChanged(params string[])</c></item>
|
||||
<item><c>NotifyChanged{T}(Expression{Func{T}})</c></item>
|
||||
<item><c>NotifyChanged{T,U}(Expression{Func{T,U}})</c></item>
|
||||
<item><c>SetProperty{T}(ref T, T, string)</c></item>
|
||||
</list>
|
||||
</remarks>
|
||||
<example><code>
|
||||
public class Foo : INotifyPropertyChanged {
|
||||
public event PropertyChangedEventHandler PropertyChanged;
|
||||
|
||||
[NotifyPropertyChangedInvocator]
|
||||
protected virtual void NotifyChanged(string propertyName) { ... }
|
||||
|
||||
string _name;
|
||||
|
||||
public string Name {
|
||||
get { return _name; }
|
||||
set { _name = value; NotifyChanged("LastName"); /* Warning */ }
|
||||
}
|
||||
}
|
||||
</code>
|
||||
Examples of generated notifications:
|
||||
<list>
|
||||
<item><c>NotifyChanged("Property")</c></item>
|
||||
<item><c>NotifyChanged(() => Property)</c></item>
|
||||
<item><c>NotifyChanged((VM x) => x.Property)</c></item>
|
||||
<item><c>SetProperty(ref myField, value, "Property")</c></item>
|
||||
</list>
|
||||
</example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ContractAnnotationAttribute">
|
||||
<summary>
|
||||
Describes dependency between method input and output.
|
||||
</summary>
|
||||
<syntax>
|
||||
<p>Function Definition Table syntax:</p>
|
||||
<list>
|
||||
<item>FDT ::= FDTRow [;FDTRow]*</item>
|
||||
<item>FDTRow ::= Input => Output | Output <= Input</item>
|
||||
<item>Input ::= ParameterName: Value [, Input]*</item>
|
||||
<item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item>
|
||||
<item>Value ::= true | false | null | notnull | canbenull</item>
|
||||
</list>
|
||||
If the method has a single input parameter, its name could be omitted.<br/>
|
||||
Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same) for the method output
|
||||
means that the method doesn't return normally (throws or terminates the process).<br/>
|
||||
Value <c>canbenull</c> is only applicable for output parameters.<br/>
|
||||
You can use multiple <c>[ContractAnnotation]</c> for each FDT row, or use single attribute
|
||||
with rows separated by the semicolon. There is no notion of order rows, all rows are checked
|
||||
for applicability and applied per each program state tracked by the analysis engine.<br/>
|
||||
</syntax>
|
||||
<examples><list>
|
||||
<item><code>
|
||||
[ContractAnnotation("=> halt")]
|
||||
public void TerminationMethod()
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("null <= param:null")] // reverse condition syntax
|
||||
public string GetName(string surname)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("s:null => true")]
|
||||
public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty()
|
||||
</code></item>
|
||||
<item><code>
|
||||
// A method that returns null if the parameter is null,
|
||||
// and not null if the parameter is not null
|
||||
[ContractAnnotation("null => null; notnull => notnull")]
|
||||
public object Transform(object data)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("=> true, result: notnull; => false, result: null")]
|
||||
public bool TryParse(string s, out Person result)
|
||||
</code></item>
|
||||
</list></examples>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.LocalizationRequiredAttribute">
|
||||
<summary>
|
||||
Indicates whether the marked element should be localized.
|
||||
</summary>
|
||||
<example><code>
|
||||
[LocalizationRequiredAttribute(true)]
|
||||
class Foo {
|
||||
string str = "my string"; // Warning: Localizable string
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute">
|
||||
<summary>
|
||||
Indicates that the value of the marked type (or its derivatives)
|
||||
cannot be compared using '==' or '!=' operators and <c>Equals()</c>
|
||||
should be used instead. However, using '==' or '!=' for comparison
|
||||
with <c>null</c> is always permitted.
|
||||
</summary>
|
||||
<example><code>
|
||||
[CannotApplyEqualityOperator]
|
||||
class NoEquality { }
|
||||
|
||||
class UsesNoEquality {
|
||||
void Test() {
|
||||
var ca1 = new NoEquality();
|
||||
var ca2 = new NoEquality();
|
||||
if (ca1 != null) { // OK
|
||||
bool condition = ca1 == ca2; // Warning
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.BaseTypeRequiredAttribute">
|
||||
<summary>
|
||||
When applied to a target attribute, specifies a requirement for any type marked
|
||||
with the target attribute to implement or inherit specific type or types.
|
||||
</summary>
|
||||
<example><code>
|
||||
[BaseTypeRequired(typeof(IComponent)] // Specify requirement
|
||||
class ComponentAttribute : Attribute { }
|
||||
|
||||
[Component] // ComponentAttribute requires implementing IComponent interface
|
||||
class MyComponent : IComponent { }
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
|
||||
<summary>
|
||||
Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
|
||||
so this symbol will be ignored by usage-checking inspections. <br/>
|
||||
You can use <see cref="T:JetBrains.Annotations.ImplicitUseKindFlags"/> and <see cref="T:JetBrains.Annotations.ImplicitUseTargetFlags"/>
|
||||
to configure how this attribute is applied.
|
||||
</summary>
|
||||
<example><code>
|
||||
[UsedImplicitly]
|
||||
public class TypeConverter {}
|
||||
|
||||
public class SummaryData
|
||||
{
|
||||
[UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)]
|
||||
public SummaryData() {}
|
||||
}
|
||||
|
||||
[UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)]
|
||||
public interface IService {}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
|
||||
<summary>
|
||||
Can be applied to attributes, type parameters, and parameters of a type assignable from <see cref="T:System.Type"/> .
|
||||
When applied to an attribute, the decorated attribute behaves the same as <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
|
||||
When applied to a type parameter or to a parameter of type <see cref="T:System.Type"/>,
|
||||
indicates that the corresponding type is used implicitly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ImplicitUseKindFlags">
|
||||
<summary>
|
||||
Specifies the details of implicitly used symbol when it is marked
|
||||
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access">
|
||||
<summary>Only entity marked with attribute considered used.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign">
|
||||
<summary>Indicates implicit assignment to a member.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature">
|
||||
<summary>
|
||||
Indicates implicit instantiation of a type with fixed constructor signature.
|
||||
That means any unused constructor parameters won't be reported as such.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature">
|
||||
<summary>Indicates implicit instantiation of a type.</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ImplicitUseTargetFlags">
|
||||
<summary>
|
||||
Specifies what is considered to be used implicitly when marked
|
||||
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members">
|
||||
<summary>Members of the type marked with the attribute are considered used.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithInheritors">
|
||||
<summary> Inherited entities are considered used. </summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers">
|
||||
<summary>Entity marked with the attribute and all its members considered used.</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.PublicAPIAttribute">
|
||||
<summary>
|
||||
This attribute is intended to mark publicly available API,
|
||||
which should not be removed and so is treated as used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.InstantHandleAttribute">
|
||||
<summary>
|
||||
Tells the code analysis engine if the parameter is completely handled when the invoked method is on stack.
|
||||
If the parameter is a delegate, indicates that delegate is executed while the method is executed.
|
||||
If the parameter is an enumerable, indicates that it is enumerated while the method is executed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.PureAttribute">
|
||||
<summary>
|
||||
Indicates that a method does not make any observable state changes.
|
||||
The same as <c>System.Diagnostics.Contracts.PureAttribute</c>.
|
||||
</summary>
|
||||
<example><code>
|
||||
[Pure] int Multiply(int x, int y) => x * y;
|
||||
|
||||
void M() {
|
||||
Multiply(123, 42); // Warning: Return value of pure method is not used
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.MustUseReturnValueAttribute">
|
||||
<summary>
|
||||
Indicates that the return value of the method invocation must be used.
|
||||
</summary>
|
||||
<remarks>
|
||||
Methods decorated with this attribute (in contrast to pure methods) might change state,
|
||||
but make no sense without using their return value. <br/>
|
||||
Similarly to <see cref="T:JetBrains.Annotations.PureAttribute"/>, this attribute
|
||||
will help to detect usages of the method when the return value is not used.
|
||||
Optionally, you can specify a message to use when showing warnings, e.g.
|
||||
<code>[MustUseReturnValue("Use the return value to...")]</code>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RequireStaticDelegateAttribute">
|
||||
<summary>
|
||||
This annotation allows to enforce allocation-less usage patterns of delegates for performance-critical APIs.
|
||||
When this annotation is applied to the parameter of delegate type, IDE checks the input argument of this parameter:
|
||||
* When lambda expression or anonymous method is passed as an argument, IDE verifies that the passed closure
|
||||
has no captures of the containing local variables and the compiler is able to cache the delegate instance
|
||||
to avoid heap allocations. Otherwise the warning is produced.
|
||||
* IDE warns when method name or local function name is passed as an argument as this always results
|
||||
in heap allocation of the delegate instance.
|
||||
</summary>
|
||||
<remarks>
|
||||
In C# 9.0 code IDE would also suggest to annotate the anonymous function with 'static' modifier
|
||||
to make use of the similar analysis provided by the language/compiler.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ProvidesContextAttribute">
|
||||
<summary>
|
||||
Indicates the type member or parameter of some type, that should be used instead of all other ways
|
||||
to get the value of that type. This annotation is useful when you have some "context" value evaluated
|
||||
and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one.
|
||||
</summary>
|
||||
<example><code>
|
||||
class Foo {
|
||||
[ProvidesContext] IBarService _barService = ...;
|
||||
|
||||
void ProcessNode(INode node) {
|
||||
DoSomething(node, node.GetGlobalServices().Bar);
|
||||
// ^ Warning: use value of '_barService' field
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.PathReferenceAttribute">
|
||||
<summary>
|
||||
Indicates that a parameter is a path to a file or a folder within a web project.
|
||||
Path can be relative or absolute, starting from web root (~).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.SourceTemplateAttribute">
|
||||
<summary>
|
||||
An extension method marked with this attribute is processed by code completion
|
||||
as a 'Source Template'. When the extension method is completed over some expression, its source code
|
||||
is automatically expanded like a template at call site.
|
||||
</summary>
|
||||
<remarks>
|
||||
Template method body can contain valid source code and/or special comments starting with '$'.
|
||||
Text inside these comments is added as source code when the template is applied. Template parameters
|
||||
can be used either as additional method parameters or as identifiers wrapped in two '$' signs.
|
||||
Use the <see cref="T:JetBrains.Annotations.MacroAttribute"/> attribute to specify macros for parameters.
|
||||
</remarks>
|
||||
<example>
|
||||
In this example, the 'forEach' method is a source template available over all values
|
||||
of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block:
|
||||
<code>
|
||||
[SourceTemplate]
|
||||
public static void forEach<T>(this IEnumerable<T> xs) {
|
||||
foreach (var x in xs) {
|
||||
//$ $END$
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.MacroAttribute">
|
||||
<summary>
|
||||
Allows specifying a macro for a parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>.
|
||||
</summary>
|
||||
<remarks>
|
||||
You can apply the attribute on the whole method or on any of its additional parameters. The macro expression
|
||||
is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Expression"/> property. When applied on a method, the target
|
||||
template parameter is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Target"/> property. To apply the macro silently
|
||||
for the parameter, set the <see cref="P:JetBrains.Annotations.MacroAttribute.Editable"/> property value = -1.
|
||||
</remarks>
|
||||
<example>
|
||||
Applying the attribute on a source template method:
|
||||
<code>
|
||||
[SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")]
|
||||
public static void forEach<T>(this IEnumerable<T> collection) {
|
||||
foreach (var item in collection) {
|
||||
//$ $END$
|
||||
}
|
||||
}
|
||||
</code>
|
||||
Applying the attribute on a template method parameter:
|
||||
<code>
|
||||
[SourceTemplate]
|
||||
public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) {
|
||||
/*$ var $x$Id = "$newguid$" + x.ToString();
|
||||
x.DoSomething($x$Id); */
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="P:JetBrains.Annotations.MacroAttribute.Expression">
|
||||
<summary>
|
||||
Allows specifying a macro that will be executed for a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>
|
||||
parameter when the template is expanded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:JetBrains.Annotations.MacroAttribute.Editable">
|
||||
<summary>
|
||||
Allows specifying which occurrence of the target parameter becomes editable when the template is deployed.
|
||||
</summary>
|
||||
<remarks>
|
||||
If the target parameter is used several times in the template, only one occurrence becomes editable;
|
||||
other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence,
|
||||
use values >= 0. To make the parameter non-editable when the template is expanded, use -1.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:JetBrains.Annotations.MacroAttribute.Target">
|
||||
<summary>
|
||||
Identifies the target parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see> if the
|
||||
<see cref="T:JetBrains.Annotations.MacroAttribute"/> is applied on a template method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcActionAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
||||
is an MVC action. If applied to a method, the MVC action name is calculated
|
||||
implicitly from the context. Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcAreaAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC area.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcControllerAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is
|
||||
an MVC controller. If applied to a method, the MVC controller name is calculated
|
||||
implicitly from the context. Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcMasterAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC Master. Use this attribute
|
||||
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcModelTypeAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC model type. Use this attribute
|
||||
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, Object)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcPartialViewAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC
|
||||
partial view. If applied to a method, the MVC partial view name is calculated implicitly
|
||||
from the context. Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcSuppressViewErrorAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcDisplayTemplateAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that a parameter is an MVC display template.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcEditorTemplateAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC editor template.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcTemplateAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC template.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcViewAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
||||
is an MVC view component. If applied to a method, the MVC view name is calculated implicitly
|
||||
from the context. Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Controller.View(Object)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcViewComponentAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
||||
is an MVC view component name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcViewComponentViewAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
||||
is an MVC view component view. If applied to a method, the MVC view component view name is default.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcActionSelectorAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. When applied to a parameter of an attribute,
|
||||
indicates that this parameter is an MVC action name.
|
||||
</summary>
|
||||
<example><code>
|
||||
[ActionName("Foo")]
|
||||
public ActionResult Login(string returnUrl) {
|
||||
ViewBag.ReturnUrl = Url.Action("Foo"); // OK
|
||||
return RedirectToAction("Bar"); // Error: Cannot resolve action
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RazorSectionAttribute">
|
||||
<summary>
|
||||
Razor attribute. Indicates that the marked parameter or method is a Razor section.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.WebPages.WebPageBase.RenderSection(String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.CollectionAccessAttribute">
|
||||
<summary>
|
||||
Indicates how method, constructor invocation, or property access
|
||||
over collection type affects the contents of the collection.
|
||||
Use <see cref="P:JetBrains.Annotations.CollectionAccessAttribute.CollectionAccessType"/> to specify the access type.
|
||||
</summary>
|
||||
<remarks>
|
||||
Using this attribute only makes sense if all collection methods are marked with this attribute.
|
||||
</remarks>
|
||||
<example><code>
|
||||
public class MyStringCollection : List<string>
|
||||
{
|
||||
[CollectionAccess(CollectionAccessType.Read)]
|
||||
public string GetFirstString()
|
||||
{
|
||||
return this.ElementAt(0);
|
||||
}
|
||||
}
|
||||
class Test
|
||||
{
|
||||
public void Foo()
|
||||
{
|
||||
// Warning: Contents of the collection is never updated
|
||||
var col = new MyStringCollection();
|
||||
string x = col.GetFirstString();
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.CollectionAccessType">
|
||||
<summary>
|
||||
Provides a value for the <see cref="T:JetBrains.Annotations.CollectionAccessAttribute"/> to define
|
||||
how the collection method invocation affects the contents of the collection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.CollectionAccessType.None">
|
||||
<summary>Method does not use or modify content of the collection.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.CollectionAccessType.Read">
|
||||
<summary>Method only reads content of the collection but does not modify it.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.CollectionAccessType.ModifyExistingContent">
|
||||
<summary>Method can change content of the collection but does not add new elements.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.CollectionAccessType.UpdatedContent">
|
||||
<summary>Method can add new elements to the collection.</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AssertionMethodAttribute">
|
||||
<summary>
|
||||
Indicates that the marked method is assertion method, i.e. it halts the control flow if
|
||||
one of the conditions is satisfied. To set the condition, mark one of the parameters with
|
||||
<see cref="T:JetBrains.Annotations.AssertionConditionAttribute"/> attribute.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AssertionConditionAttribute">
|
||||
<summary>
|
||||
Indicates the condition parameter of the assertion method. The method itself should be
|
||||
marked by <see cref="T:JetBrains.Annotations.AssertionMethodAttribute"/> attribute. The mandatory argument of
|
||||
the attribute is the assertion type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AssertionConditionType">
|
||||
<summary>
|
||||
Specifies assertion type. If the assertion method argument satisfies the condition,
|
||||
then the execution continues. Otherwise, execution is assumed to be halted.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_TRUE">
|
||||
<summary>Marked parameter should be evaluated to true.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_FALSE">
|
||||
<summary>Marked parameter should be evaluated to false.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NULL">
|
||||
<summary>Marked parameter should be evaluated to null value.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NOT_NULL">
|
||||
<summary>Marked parameter should be evaluated to not null value.</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.TerminatesProgramAttribute">
|
||||
<summary>
|
||||
Indicates that the marked method unconditionally terminates control flow execution.
|
||||
For example, it could unconditionally throw exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.LinqTunnelAttribute">
|
||||
<summary>
|
||||
Indicates that the method is a pure LINQ method, with postponed enumeration (like Enumerable.Select,
|
||||
.Where). This annotation allows inference of [InstantHandle] annotation for parameters
|
||||
of delegate type by analyzing LINQ method chains.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NoEnumerationAttribute">
|
||||
<summary>
|
||||
Indicates that IEnumerable passed as a parameter is not enumerated.
|
||||
Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection.
|
||||
</summary>
|
||||
<example><code>
|
||||
static void ThrowIfNull<T>([NoEnumeration] T v, string n) where T : class
|
||||
{
|
||||
// custom check for null but no enumeration
|
||||
}
|
||||
|
||||
void Foo(IEnumerable<string> values)
|
||||
{
|
||||
ThrowIfNull(values, nameof(values));
|
||||
var x = values.ToList(); // No warnings about multiple enumeration
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RegexPatternAttribute">
|
||||
<summary>
|
||||
Indicates that the marked parameter, field, or property is a regular expression pattern.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NoReorderAttribute">
|
||||
<summary>
|
||||
Prevents the Member Reordering feature from tossing members of the marked class.
|
||||
</summary>
|
||||
<remarks>
|
||||
The attribute must be mentioned in your member reordering patterns.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlItemsControlAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates the type that has <c>ItemsSource</c> property and should be treated
|
||||
as <c>ItemsControl</c>-derived type, to enable inner items <c>DataContext</c> type resolve.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlItemBindingOfItemsControlAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates the property of some <c>BindingBase</c>-derived type, that
|
||||
is used to bind some item of <c>ItemsControl</c>-derived type. This annotation will
|
||||
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
|
||||
</summary>
|
||||
<remarks>
|
||||
Property should have the tree ancestor of the <c>ItemsControl</c> type or
|
||||
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlItemStyleOfItemsControlAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates the property of some <c>Style</c>-derived type, that
|
||||
is used to style items of <c>ItemsControl</c>-derived type. This annotation will
|
||||
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
|
||||
</summary>
|
||||
<remarks>
|
||||
Property should have the tree ancestor of the <c>ItemsControl</c> type or
|
||||
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlOneWayBindingModeByDefaultAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates that DependencyProperty has <c>OneWay</c> binding mode by default.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlTwoWayBindingModeByDefaultAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates that DependencyProperty has <c>TwoWay</c> binding mode by default.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RouteTemplateAttribute">
|
||||
<summary>
|
||||
Indicates that the marked parameter, field, or property is a route template.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute allows IDE to recognize the use of web frameworks' route templates
|
||||
to enable syntax highlighting, code completion, navigation, rename and other features in string literals.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RouteParameterConstraintAttribute">
|
||||
<summary>
|
||||
Indicates that the marked type is custom route parameter constraint,
|
||||
which is registered in application's Startup with name <c>ConstraintName</c>
|
||||
</summary>
|
||||
<remarks>
|
||||
You can specify <c>ProposedType</c> if target constraint matches only route parameters of specific type,
|
||||
it will allow IDE to create method's parameter from usage in route template
|
||||
with specified type instead of default <c>System.String</c>
|
||||
and check if constraint's proposed type conflicts with matched parameter's type
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.UriStringAttribute">
|
||||
<summary>
|
||||
Indicates that the marked parameter, field, or property is an URI string.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute enables code completion, navigation, rename and other features
|
||||
in URI string literals assigned to annotated parameter, field or property.
|
||||
</remarks>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,386 +0,0 @@
|
||||
{
|
||||
"runtimeTarget": {
|
||||
"name": ".NETStandard,Version=v1.0/",
|
||||
"signature": ""
|
||||
},
|
||||
"compilationOptions": {},
|
||||
"targets": {
|
||||
".NETStandard,Version=v1.0": {},
|
||||
".NETStandard,Version=v1.0/": {
|
||||
"JetBrains.Annotations/2021.2": {
|
||||
"dependencies": {
|
||||
"NETStandard.Library": "1.6.0"
|
||||
},
|
||||
"runtime": {
|
||||
"JetBrains.Annotations.dll": {}
|
||||
}
|
||||
},
|
||||
"Microsoft.NETCore.Platforms/1.0.1": {},
|
||||
"Microsoft.NETCore.Targets/1.0.1": {},
|
||||
"NETStandard.Library/1.6.0": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"System.Collections": "4.0.11",
|
||||
"System.Diagnostics.Debug": "4.0.11",
|
||||
"System.Diagnostics.Tools": "4.0.1",
|
||||
"System.Globalization": "4.0.11",
|
||||
"System.IO": "4.1.0",
|
||||
"System.Linq": "4.1.0",
|
||||
"System.Linq.Expressions": "4.1.0",
|
||||
"System.Net.Primitives": "4.0.11",
|
||||
"System.ObjectModel": "4.0.12",
|
||||
"System.Reflection": "4.1.0",
|
||||
"System.Reflection.Extensions": "4.0.1",
|
||||
"System.Reflection.Primitives": "4.0.1",
|
||||
"System.Resources.ResourceManager": "4.0.1",
|
||||
"System.Runtime": "4.1.0",
|
||||
"System.Runtime.Extensions": "4.1.0",
|
||||
"System.Text.Encoding": "4.0.11",
|
||||
"System.Text.Encoding.Extensions": "4.0.11",
|
||||
"System.Text.RegularExpressions": "4.1.0",
|
||||
"System.Threading": "4.0.11",
|
||||
"System.Threading.Tasks": "4.0.11",
|
||||
"System.Xml.ReaderWriter": "4.0.11",
|
||||
"System.Xml.XDocument": "4.0.11"
|
||||
}
|
||||
},
|
||||
"System.Collections/4.0.11": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Diagnostics.Debug/4.0.11": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Diagnostics.Tools/4.0.1": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Globalization/4.0.11": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.IO/4.1.0": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0",
|
||||
"System.Text.Encoding": "4.0.11",
|
||||
"System.Threading.Tasks": "4.0.11"
|
||||
}
|
||||
},
|
||||
"System.Linq/4.1.0": {
|
||||
"dependencies": {
|
||||
"System.Collections": "4.0.11",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Linq.Expressions/4.1.0": {
|
||||
"dependencies": {
|
||||
"System.Reflection": "4.1.0",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Net.Primitives/4.0.11": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.ObjectModel/4.0.12": {
|
||||
"dependencies": {
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Reflection/4.1.0": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.IO": "4.1.0",
|
||||
"System.Reflection.Primitives": "4.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Reflection.Extensions/4.0.1": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Reflection": "4.1.0",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Reflection.Primitives/4.0.1": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Resources.ResourceManager/4.0.1": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Globalization": "4.0.11",
|
||||
"System.Reflection": "4.1.0",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Runtime/4.1.0": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1"
|
||||
}
|
||||
},
|
||||
"System.Runtime.Extensions/4.1.0": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Text.Encoding/4.0.11": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Text.Encoding.Extensions/4.0.11": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0",
|
||||
"System.Text.Encoding": "4.0.11"
|
||||
}
|
||||
},
|
||||
"System.Text.RegularExpressions/4.1.0": {
|
||||
"dependencies": {
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Threading/4.0.11": {
|
||||
"dependencies": {
|
||||
"System.Runtime": "4.1.0",
|
||||
"System.Threading.Tasks": "4.0.11"
|
||||
}
|
||||
},
|
||||
"System.Threading.Tasks/4.0.11": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.0.1",
|
||||
"Microsoft.NETCore.Targets": "1.0.1",
|
||||
"System.Runtime": "4.1.0"
|
||||
}
|
||||
},
|
||||
"System.Xml.ReaderWriter/4.0.11": {
|
||||
"dependencies": {
|
||||
"System.IO": "4.1.0",
|
||||
"System.Runtime": "4.1.0",
|
||||
"System.Text.Encoding": "4.0.11",
|
||||
"System.Threading.Tasks": "4.0.11"
|
||||
}
|
||||
},
|
||||
"System.Xml.XDocument/4.0.11": {
|
||||
"dependencies": {
|
||||
"System.IO": "4.1.0",
|
||||
"System.Runtime": "4.1.0",
|
||||
"System.Xml.ReaderWriter": "4.0.11"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"libraries": {
|
||||
"JetBrains.Annotations/2021.2": {
|
||||
"type": "project",
|
||||
"serviceable": false,
|
||||
"sha512": ""
|
||||
},
|
||||
"Microsoft.NETCore.Platforms/1.0.1": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-2G6OjjJzwBfNOO8myRV/nFrbTw5iA+DEm0N+qUqhrOmaVtn4pC77h38I1jsXGw5VH55+dPfQsqHD0We9sCl9FQ==",
|
||||
"path": "microsoft.netcore.platforms/1.0.1",
|
||||
"hashPath": "microsoft.netcore.platforms.1.0.1.nupkg.sha512"
|
||||
},
|
||||
"Microsoft.NETCore.Targets/1.0.1": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-rkn+fKobF/cbWfnnfBOQHKVKIOpxMZBvlSHkqDWgBpwGDcLRduvs3D9OLGeV6GWGvVwNlVi2CBbTjuPmtHvyNw==",
|
||||
"path": "microsoft.netcore.targets/1.0.1",
|
||||
"hashPath": "microsoft.netcore.targets.1.0.1.nupkg.sha512"
|
||||
},
|
||||
"NETStandard.Library/1.6.0": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-ypsCvIdCZ4IoYASJHt6tF2fMo7N30NLgV1EbmC+snO490OMl9FvVxmumw14rhReWU3j3g7BYudG6YCrchwHJlA==",
|
||||
"path": "netstandard.library/1.6.0",
|
||||
"hashPath": "netstandard.library.1.6.0.nupkg.sha512"
|
||||
},
|
||||
"System.Collections/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-YUJGz6eFKqS0V//mLt25vFGrrCvOnsXjlvFQs+KimpwNxug9x0Pzy4PlFMU3Q2IzqAa9G2L4LsK3+9vCBK7oTg==",
|
||||
"path": "system.collections/4.0.11",
|
||||
"hashPath": "system.collections.4.0.11.nupkg.sha512"
|
||||
},
|
||||
"System.Diagnostics.Debug/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-w5U95fVKHY4G8ASs/K5iK3J5LY+/dLFd4vKejsnI/ZhBsWS9hQakfx3Zr7lRWKg4tAw9r4iktyvsTagWkqYCiw==",
|
||||
"path": "system.diagnostics.debug/4.0.11",
|
||||
"hashPath": "system.diagnostics.debug.4.0.11.nupkg.sha512"
|
||||
},
|
||||
"System.Diagnostics.Tools/4.0.1": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-xBfJ8pnd4C17dWaC9FM6aShzbJcRNMChUMD42I6772KGGrqaFdumwhn9OdM68erj1ueNo3xdQ1EwiFjK5k8p0g==",
|
||||
"path": "system.diagnostics.tools/4.0.1",
|
||||
"hashPath": "system.diagnostics.tools.4.0.1.nupkg.sha512"
|
||||
},
|
||||
"System.Globalization/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-B95h0YLEL2oSnwF/XjqSWKnwKOy/01VWkNlsCeMTFJLLabflpGV26nK164eRs5GiaRSBGpOxQ3pKoSnnyZN5pg==",
|
||||
"path": "system.globalization/4.0.11",
|
||||
"hashPath": "system.globalization.4.0.11.nupkg.sha512"
|
||||
},
|
||||
"System.IO/4.1.0": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-3KlTJceQc3gnGIaHZ7UBZO26SHL1SHE4ddrmiwumFnId+CEHP+O8r386tZKaE6zlk5/mF8vifMBzHj9SaXN+mQ==",
|
||||
"path": "system.io/4.1.0",
|
||||
"hashPath": "system.io.4.1.0.nupkg.sha512"
|
||||
},
|
||||
"System.Linq/4.1.0": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-bQ0iYFOQI0nuTnt+NQADns6ucV4DUvMdwN6CbkB1yj8i7arTGiTN5eok1kQwdnnNWSDZfIUySQY+J3d5KjWn0g==",
|
||||
"path": "system.linq/4.1.0",
|
||||
"hashPath": "system.linq.4.1.0.nupkg.sha512"
|
||||
},
|
||||
"System.Linq.Expressions/4.1.0": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-I+y02iqkgmCAyfbqOmSDOgqdZQ5tTj80Akm5BPSS8EeB0VGWdy6X1KCoYe8Pk6pwDoAKZUOdLVxnTJcExiv5zw==",
|
||||
"path": "system.linq.expressions/4.1.0",
|
||||
"hashPath": "system.linq.expressions.4.1.0.nupkg.sha512"
|
||||
},
|
||||
"System.Net.Primitives/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-hVvfl4405DRjA2408luZekbPhplJK03j2Y2lSfMlny7GHXlkByw1iLnc9mgKW0GdQn73vvMcWrWewAhylXA4Nw==",
|
||||
"path": "system.net.primitives/4.0.11",
|
||||
"hashPath": "system.net.primitives.4.0.11.nupkg.sha512"
|
||||
},
|
||||
"System.ObjectModel/4.0.12": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-tAgJM1xt3ytyMoW4qn4wIqgJYm7L7TShRZG4+Q4Qsi2PCcj96pXN7nRywS9KkB3p/xDUjc2HSwP9SROyPYDYKQ==",
|
||||
"path": "system.objectmodel/4.0.12",
|
||||
"hashPath": "system.objectmodel.4.0.12.nupkg.sha512"
|
||||
},
|
||||
"System.Reflection/4.1.0": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-JCKANJ0TI7kzoQzuwB/OoJANy1Lg338B6+JVacPl4TpUwi3cReg3nMLplMq2uqYfHFQpKIlHAUVAJlImZz/4ng==",
|
||||
"path": "system.reflection/4.1.0",
|
||||
"hashPath": "system.reflection.4.1.0.nupkg.sha512"
|
||||
},
|
||||
"System.Reflection.Extensions/4.0.1": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-GYrtRsZcMuHF3sbmRHfMYpvxZoIN2bQGrYGerUiWLEkqdEUQZhH3TRSaC/oI4wO0II1RKBPlpIa1TOMxIcOOzQ==",
|
||||
"path": "system.reflection.extensions/4.0.1",
|
||||
"hashPath": "system.reflection.extensions.4.0.1.nupkg.sha512"
|
||||
},
|
||||
"System.Reflection.Primitives/4.0.1": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-4inTox4wTBaDhB7V3mPvp9XlCbeGYWVEM9/fXALd52vNEAVisc1BoVWQPuUuD0Ga//dNbA/WeMy9u9mzLxGTHQ==",
|
||||
"path": "system.reflection.primitives/4.0.1",
|
||||
"hashPath": "system.reflection.primitives.4.0.1.nupkg.sha512"
|
||||
},
|
||||
"System.Resources.ResourceManager/4.0.1": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-TxwVeUNoTgUOdQ09gfTjvW411MF+w9MBYL7AtNVc+HtBCFlutPLhUCdZjNkjbhj3bNQWMdHboF0KIWEOjJssbA==",
|
||||
"path": "system.resources.resourcemanager/4.0.1",
|
||||
"hashPath": "system.resources.resourcemanager.4.0.1.nupkg.sha512"
|
||||
},
|
||||
"System.Runtime/4.1.0": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-v6c/4Yaa9uWsq+JMhnOFewrYkgdNHNG2eMKuNqRn8P733rNXeRCGvV5FkkjBXn2dbVkPXOsO0xjsEeM1q2zC0g==",
|
||||
"path": "system.runtime/4.1.0",
|
||||
"hashPath": "system.runtime.4.1.0.nupkg.sha512"
|
||||
},
|
||||
"System.Runtime.Extensions/4.1.0": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-CUOHjTT/vgP0qGW22U4/hDlOqXmcPq5YicBaXdUR2UiUoLwBT+olO6we4DVbq57jeX5uXH2uerVZhf0qGj+sVQ==",
|
||||
"path": "system.runtime.extensions/4.1.0",
|
||||
"hashPath": "system.runtime.extensions.4.1.0.nupkg.sha512"
|
||||
},
|
||||
"System.Text.Encoding/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-U3gGeMlDZXxCEiY4DwVLSacg+DFWCvoiX+JThA/rvw37Sqrku7sEFeVBBBMBnfB6FeZHsyDx85HlKL19x0HtZA==",
|
||||
"path": "system.text.encoding/4.0.11",
|
||||
"hashPath": "system.text.encoding.4.0.11.nupkg.sha512"
|
||||
},
|
||||
"System.Text.Encoding.Extensions/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-jtbiTDtvfLYgXn8PTfWI+SiBs51rrmO4AAckx4KR6vFK9Wzf6tI8kcRdsYQNwriUeQ1+CtQbM1W4cMbLXnj/OQ==",
|
||||
"path": "system.text.encoding.extensions/4.0.11",
|
||||
"hashPath": "system.text.encoding.extensions.4.0.11.nupkg.sha512"
|
||||
},
|
||||
"System.Text.RegularExpressions/4.1.0": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-i88YCXpRTjCnoSQZtdlHkAOx4KNNik4hMy83n0+Ftlb7jvV6ZiZWMpnEZHhjBp6hQVh8gWd/iKNPzlPF7iyA2g==",
|
||||
"path": "system.text.regularexpressions/4.1.0",
|
||||
"hashPath": "system.text.regularexpressions.4.1.0.nupkg.sha512"
|
||||
},
|
||||
"System.Threading/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-N+3xqIcg3VDKyjwwCGaZ9HawG9aC6cSDI+s7ROma310GQo8vilFZa86hqKppwTHleR/G0sfOzhvgnUxWCR/DrQ==",
|
||||
"path": "system.threading/4.0.11",
|
||||
"hashPath": "system.threading.4.0.11.nupkg.sha512"
|
||||
},
|
||||
"System.Threading.Tasks/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-k1S4Gc6IGwtHGT8188RSeGaX86Qw/wnrgNLshJvsdNUOPP9etMmo8S07c+UlOAx4K/xLuN9ivA1bD0LVurtIxQ==",
|
||||
"path": "system.threading.tasks/4.0.11",
|
||||
"hashPath": "system.threading.tasks.4.0.11.nupkg.sha512"
|
||||
},
|
||||
"System.Xml.ReaderWriter/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-ZIiLPsf67YZ9zgr31vzrFaYQqxRPX9cVHjtPSnmx4eN6lbS/yEyYNr2vs1doGDEscF0tjCZFsk9yUg1sC9e8tg==",
|
||||
"path": "system.xml.readerwriter/4.0.11",
|
||||
"hashPath": "system.xml.readerwriter.4.0.11.nupkg.sha512"
|
||||
},
|
||||
"System.Xml.XDocument/4.0.11": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-Mk2mKmPi0nWaoiYeotq1dgeNK1fqWh61+EK+w4Wu8SWuTYLzpUnschb59bJtGywaPq7SmTuPf44wrXRwbIrukg==",
|
||||
"path": "system.xml.xdocument/4.0.11",
|
||||
"hashPath": "system.xml.xdocument.4.0.11.nupkg.sha512"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,823 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>JetBrains.Annotations</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:JetBrains.Annotations.CanBeNullAttribute">
|
||||
<summary>
|
||||
Indicates that the value of the marked element could be <c>null</c> sometimes,
|
||||
so checking for <c>null</c> is required before its usage.
|
||||
</summary>
|
||||
<example><code>
|
||||
[CanBeNull] object Test() => null;
|
||||
|
||||
void UseTest() {
|
||||
var p = Test();
|
||||
var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NotNullAttribute">
|
||||
<summary>
|
||||
Indicates that the value of the marked element can never be <c>null</c>.
|
||||
</summary>
|
||||
<example><code>
|
||||
[NotNull] object Foo() {
|
||||
return null; // Warning: Possible 'null' assignment
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ItemNotNullAttribute">
|
||||
<summary>
|
||||
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
|
||||
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
|
||||
or of the Lazy.Value property can never be null.
|
||||
</summary>
|
||||
<example><code>
|
||||
public void Foo([ItemNotNull]List<string> books)
|
||||
{
|
||||
foreach (var book in books) {
|
||||
if (book != null) // Warning: Expression is always true
|
||||
Console.WriteLine(book.ToUpper());
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ItemCanBeNullAttribute">
|
||||
<summary>
|
||||
Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task
|
||||
and Lazy classes to indicate that the value of a collection item, of the Task.Result property
|
||||
or of the Lazy.Value property can be null.
|
||||
</summary>
|
||||
<example><code>
|
||||
public void Foo([ItemCanBeNull]List<string> books)
|
||||
{
|
||||
foreach (var book in books)
|
||||
{
|
||||
// Warning: Possible 'System.NullReferenceException'
|
||||
Console.WriteLine(book.ToUpper());
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.StringFormatMethodAttribute">
|
||||
<summary>
|
||||
Indicates that the marked method builds string by the format pattern and (optional) arguments.
|
||||
The parameter, which contains the format string, should be given in the constructor. The format string
|
||||
should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>-like form.
|
||||
</summary>
|
||||
<example><code>
|
||||
[StringFormatMethod("message")]
|
||||
void ShowError(string message, params object[] args) { /* do something */ }
|
||||
|
||||
void Foo() {
|
||||
ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="M:JetBrains.Annotations.StringFormatMethodAttribute.#ctor(System.String)">
|
||||
<param name="formatParameterName">
|
||||
Specifies which parameter of an annotated method should be treated as the format string
|
||||
</param>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.StructuredMessageTemplateAttribute">
|
||||
<summary>
|
||||
Indicates that the marked parameter is a message template where placeholders are to be replaced by the following arguments
|
||||
in the order in which they appear
|
||||
</summary>
|
||||
<example><code>
|
||||
void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ }
|
||||
|
||||
void Foo() {
|
||||
LogInfo("User created: {username}"); // Warning: Non-existing argument in format string
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ValueProviderAttribute">
|
||||
<summary>
|
||||
Use this annotation to specify a type that contains static or const fields
|
||||
with values for the annotated property/field/parameter.
|
||||
The specified type will be used to improve completion suggestions.
|
||||
</summary>
|
||||
<example><code>
|
||||
namespace TestNamespace
|
||||
{
|
||||
public class Constants
|
||||
{
|
||||
public static int INT_CONST = 1;
|
||||
public const string STRING_CONST = "1";
|
||||
}
|
||||
|
||||
public class Class1
|
||||
{
|
||||
[ValueProvider("TestNamespace.Constants")] public int myField;
|
||||
public void Foo([ValueProvider("TestNamespace.Constants")] string str) { }
|
||||
|
||||
public void Test()
|
||||
{
|
||||
Foo(/*try completion here*/);//
|
||||
myField = /*try completion here*/
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ValueRangeAttribute">
|
||||
<summary>
|
||||
Indicates that the integral value falls into the specified interval.
|
||||
It's allowed to specify multiple non-intersecting intervals.
|
||||
Values of interval boundaries are inclusive.
|
||||
</summary>
|
||||
<example><code>
|
||||
void Foo([ValueRange(0, 100)] int value) {
|
||||
if (value == -1) { // Warning: Expression is always 'false'
|
||||
...
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NonNegativeValueAttribute">
|
||||
<summary>
|
||||
Indicates that the integral value never falls below zero.
|
||||
</summary>
|
||||
<example><code>
|
||||
void Foo([NonNegativeValue] int value) {
|
||||
if (value == -1) { // Warning: Expression is always 'false'
|
||||
...
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.InvokerParameterNameAttribute">
|
||||
<summary>
|
||||
Indicates that the function argument should be a string literal and match one
|
||||
of the parameters of the caller function. For example, ReSharper annotates
|
||||
the parameter of <see cref="T:System.ArgumentNullException"/>.
|
||||
</summary>
|
||||
<example><code>
|
||||
void Foo(string param) {
|
||||
if (param == null)
|
||||
throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NotifyPropertyChangedInvocatorAttribute">
|
||||
<summary>
|
||||
Indicates that the method is contained in a type that implements
|
||||
<c>System.ComponentModel.INotifyPropertyChanged</c> interface and this method
|
||||
is used to notify that some property value changed.
|
||||
</summary>
|
||||
<remarks>
|
||||
The method should be non-static and conform to one of the supported signatures:
|
||||
<list>
|
||||
<item><c>NotifyChanged(string)</c></item>
|
||||
<item><c>NotifyChanged(params string[])</c></item>
|
||||
<item><c>NotifyChanged{T}(Expression{Func{T}})</c></item>
|
||||
<item><c>NotifyChanged{T,U}(Expression{Func{T,U}})</c></item>
|
||||
<item><c>SetProperty{T}(ref T, T, string)</c></item>
|
||||
</list>
|
||||
</remarks>
|
||||
<example><code>
|
||||
public class Foo : INotifyPropertyChanged {
|
||||
public event PropertyChangedEventHandler PropertyChanged;
|
||||
|
||||
[NotifyPropertyChangedInvocator]
|
||||
protected virtual void NotifyChanged(string propertyName) { ... }
|
||||
|
||||
string _name;
|
||||
|
||||
public string Name {
|
||||
get { return _name; }
|
||||
set { _name = value; NotifyChanged("LastName"); /* Warning */ }
|
||||
}
|
||||
}
|
||||
</code>
|
||||
Examples of generated notifications:
|
||||
<list>
|
||||
<item><c>NotifyChanged("Property")</c></item>
|
||||
<item><c>NotifyChanged(() => Property)</c></item>
|
||||
<item><c>NotifyChanged((VM x) => x.Property)</c></item>
|
||||
<item><c>SetProperty(ref myField, value, "Property")</c></item>
|
||||
</list>
|
||||
</example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ContractAnnotationAttribute">
|
||||
<summary>
|
||||
Describes dependency between method input and output.
|
||||
</summary>
|
||||
<syntax>
|
||||
<p>Function Definition Table syntax:</p>
|
||||
<list>
|
||||
<item>FDT ::= FDTRow [;FDTRow]*</item>
|
||||
<item>FDTRow ::= Input => Output | Output <= Input</item>
|
||||
<item>Input ::= ParameterName: Value [, Input]*</item>
|
||||
<item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item>
|
||||
<item>Value ::= true | false | null | notnull | canbenull</item>
|
||||
</list>
|
||||
If the method has a single input parameter, its name could be omitted.<br/>
|
||||
Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same) for the method output
|
||||
means that the method doesn't return normally (throws or terminates the process).<br/>
|
||||
Value <c>canbenull</c> is only applicable for output parameters.<br/>
|
||||
You can use multiple <c>[ContractAnnotation]</c> for each FDT row, or use single attribute
|
||||
with rows separated by the semicolon. There is no notion of order rows, all rows are checked
|
||||
for applicability and applied per each program state tracked by the analysis engine.<br/>
|
||||
</syntax>
|
||||
<examples><list>
|
||||
<item><code>
|
||||
[ContractAnnotation("=> halt")]
|
||||
public void TerminationMethod()
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("null <= param:null")] // reverse condition syntax
|
||||
public string GetName(string surname)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("s:null => true")]
|
||||
public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty()
|
||||
</code></item>
|
||||
<item><code>
|
||||
// A method that returns null if the parameter is null,
|
||||
// and not null if the parameter is not null
|
||||
[ContractAnnotation("null => null; notnull => notnull")]
|
||||
public object Transform(object data)
|
||||
</code></item>
|
||||
<item><code>
|
||||
[ContractAnnotation("=> true, result: notnull; => false, result: null")]
|
||||
public bool TryParse(string s, out Person result)
|
||||
</code></item>
|
||||
</list></examples>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.LocalizationRequiredAttribute">
|
||||
<summary>
|
||||
Indicates whether the marked element should be localized.
|
||||
</summary>
|
||||
<example><code>
|
||||
[LocalizationRequiredAttribute(true)]
|
||||
class Foo {
|
||||
string str = "my string"; // Warning: Localizable string
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute">
|
||||
<summary>
|
||||
Indicates that the value of the marked type (or its derivatives)
|
||||
cannot be compared using '==' or '!=' operators and <c>Equals()</c>
|
||||
should be used instead. However, using '==' or '!=' for comparison
|
||||
with <c>null</c> is always permitted.
|
||||
</summary>
|
||||
<example><code>
|
||||
[CannotApplyEqualityOperator]
|
||||
class NoEquality { }
|
||||
|
||||
class UsesNoEquality {
|
||||
void Test() {
|
||||
var ca1 = new NoEquality();
|
||||
var ca2 = new NoEquality();
|
||||
if (ca1 != null) { // OK
|
||||
bool condition = ca1 == ca2; // Warning
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.BaseTypeRequiredAttribute">
|
||||
<summary>
|
||||
When applied to a target attribute, specifies a requirement for any type marked
|
||||
with the target attribute to implement or inherit specific type or types.
|
||||
</summary>
|
||||
<example><code>
|
||||
[BaseTypeRequired(typeof(IComponent)] // Specify requirement
|
||||
class ComponentAttribute : Attribute { }
|
||||
|
||||
[Component] // ComponentAttribute requires implementing IComponent interface
|
||||
class MyComponent : IComponent { }
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
|
||||
<summary>
|
||||
Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
|
||||
so this symbol will be ignored by usage-checking inspections. <br/>
|
||||
You can use <see cref="T:JetBrains.Annotations.ImplicitUseKindFlags"/> and <see cref="T:JetBrains.Annotations.ImplicitUseTargetFlags"/>
|
||||
to configure how this attribute is applied.
|
||||
</summary>
|
||||
<example><code>
|
||||
[UsedImplicitly]
|
||||
public class TypeConverter {}
|
||||
|
||||
public class SummaryData
|
||||
{
|
||||
[UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)]
|
||||
public SummaryData() {}
|
||||
}
|
||||
|
||||
[UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)]
|
||||
public interface IService {}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
|
||||
<summary>
|
||||
Can be applied to attributes, type parameters, and parameters of a type assignable from <see cref="T:System.Type"/> .
|
||||
When applied to an attribute, the decorated attribute behaves the same as <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
|
||||
When applied to a type parameter or to a parameter of type <see cref="T:System.Type"/>,
|
||||
indicates that the corresponding type is used implicitly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ImplicitUseKindFlags">
|
||||
<summary>
|
||||
Specifies the details of implicitly used symbol when it is marked
|
||||
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access">
|
||||
<summary>Only entity marked with attribute considered used.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign">
|
||||
<summary>Indicates implicit assignment to a member.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature">
|
||||
<summary>
|
||||
Indicates implicit instantiation of a type with fixed constructor signature.
|
||||
That means any unused constructor parameters won't be reported as such.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature">
|
||||
<summary>Indicates implicit instantiation of a type.</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ImplicitUseTargetFlags">
|
||||
<summary>
|
||||
Specifies what is considered to be used implicitly when marked
|
||||
with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members">
|
||||
<summary>Members of the type marked with the attribute are considered used.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithInheritors">
|
||||
<summary> Inherited entities are considered used. </summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers">
|
||||
<summary>Entity marked with the attribute and all its members considered used.</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.PublicAPIAttribute">
|
||||
<summary>
|
||||
This attribute is intended to mark publicly available API,
|
||||
which should not be removed and so is treated as used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.InstantHandleAttribute">
|
||||
<summary>
|
||||
Tells the code analysis engine if the parameter is completely handled when the invoked method is on stack.
|
||||
If the parameter is a delegate, indicates that delegate is executed while the method is executed.
|
||||
If the parameter is an enumerable, indicates that it is enumerated while the method is executed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.PureAttribute">
|
||||
<summary>
|
||||
Indicates that a method does not make any observable state changes.
|
||||
The same as <c>System.Diagnostics.Contracts.PureAttribute</c>.
|
||||
</summary>
|
||||
<example><code>
|
||||
[Pure] int Multiply(int x, int y) => x * y;
|
||||
|
||||
void M() {
|
||||
Multiply(123, 42); // Warning: Return value of pure method is not used
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.MustUseReturnValueAttribute">
|
||||
<summary>
|
||||
Indicates that the return value of the method invocation must be used.
|
||||
</summary>
|
||||
<remarks>
|
||||
Methods decorated with this attribute (in contrast to pure methods) might change state,
|
||||
but make no sense without using their return value. <br/>
|
||||
Similarly to <see cref="T:JetBrains.Annotations.PureAttribute"/>, this attribute
|
||||
will help to detect usages of the method when the return value is not used.
|
||||
Optionally, you can specify a message to use when showing warnings, e.g.
|
||||
<code>[MustUseReturnValue("Use the return value to...")]</code>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RequireStaticDelegateAttribute">
|
||||
<summary>
|
||||
This annotation allows to enforce allocation-less usage patterns of delegates for performance-critical APIs.
|
||||
When this annotation is applied to the parameter of delegate type, IDE checks the input argument of this parameter:
|
||||
* When lambda expression or anonymous method is passed as an argument, IDE verifies that the passed closure
|
||||
has no captures of the containing local variables and the compiler is able to cache the delegate instance
|
||||
to avoid heap allocations. Otherwise the warning is produced.
|
||||
* IDE warns when method name or local function name is passed as an argument as this always results
|
||||
in heap allocation of the delegate instance.
|
||||
</summary>
|
||||
<remarks>
|
||||
In C# 9.0 code IDE would also suggest to annotate the anonymous function with 'static' modifier
|
||||
to make use of the similar analysis provided by the language/compiler.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.ProvidesContextAttribute">
|
||||
<summary>
|
||||
Indicates the type member or parameter of some type, that should be used instead of all other ways
|
||||
to get the value of that type. This annotation is useful when you have some "context" value evaluated
|
||||
and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one.
|
||||
</summary>
|
||||
<example><code>
|
||||
class Foo {
|
||||
[ProvidesContext] IBarService _barService = ...;
|
||||
|
||||
void ProcessNode(INode node) {
|
||||
DoSomething(node, node.GetGlobalServices().Bar);
|
||||
// ^ Warning: use value of '_barService' field
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.PathReferenceAttribute">
|
||||
<summary>
|
||||
Indicates that a parameter is a path to a file or a folder within a web project.
|
||||
Path can be relative or absolute, starting from web root (~).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.SourceTemplateAttribute">
|
||||
<summary>
|
||||
An extension method marked with this attribute is processed by code completion
|
||||
as a 'Source Template'. When the extension method is completed over some expression, its source code
|
||||
is automatically expanded like a template at call site.
|
||||
</summary>
|
||||
<remarks>
|
||||
Template method body can contain valid source code and/or special comments starting with '$'.
|
||||
Text inside these comments is added as source code when the template is applied. Template parameters
|
||||
can be used either as additional method parameters or as identifiers wrapped in two '$' signs.
|
||||
Use the <see cref="T:JetBrains.Annotations.MacroAttribute"/> attribute to specify macros for parameters.
|
||||
</remarks>
|
||||
<example>
|
||||
In this example, the 'forEach' method is a source template available over all values
|
||||
of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block:
|
||||
<code>
|
||||
[SourceTemplate]
|
||||
public static void forEach<T>(this IEnumerable<T> xs) {
|
||||
foreach (var x in xs) {
|
||||
//$ $END$
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.MacroAttribute">
|
||||
<summary>
|
||||
Allows specifying a macro for a parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>.
|
||||
</summary>
|
||||
<remarks>
|
||||
You can apply the attribute on the whole method or on any of its additional parameters. The macro expression
|
||||
is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Expression"/> property. When applied on a method, the target
|
||||
template parameter is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Target"/> property. To apply the macro silently
|
||||
for the parameter, set the <see cref="P:JetBrains.Annotations.MacroAttribute.Editable"/> property value = -1.
|
||||
</remarks>
|
||||
<example>
|
||||
Applying the attribute on a source template method:
|
||||
<code>
|
||||
[SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")]
|
||||
public static void forEach<T>(this IEnumerable<T> collection) {
|
||||
foreach (var item in collection) {
|
||||
//$ $END$
|
||||
}
|
||||
}
|
||||
</code>
|
||||
Applying the attribute on a template method parameter:
|
||||
<code>
|
||||
[SourceTemplate]
|
||||
public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) {
|
||||
/*$ var $x$Id = "$newguid$" + x.ToString();
|
||||
x.DoSomething($x$Id); */
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</member>
|
||||
<member name="P:JetBrains.Annotations.MacroAttribute.Expression">
|
||||
<summary>
|
||||
Allows specifying a macro that will be executed for a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>
|
||||
parameter when the template is expanded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:JetBrains.Annotations.MacroAttribute.Editable">
|
||||
<summary>
|
||||
Allows specifying which occurrence of the target parameter becomes editable when the template is deployed.
|
||||
</summary>
|
||||
<remarks>
|
||||
If the target parameter is used several times in the template, only one occurrence becomes editable;
|
||||
other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence,
|
||||
use values >= 0. To make the parameter non-editable when the template is expanded, use -1.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:JetBrains.Annotations.MacroAttribute.Target">
|
||||
<summary>
|
||||
Identifies the target parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see> if the
|
||||
<see cref="T:JetBrains.Annotations.MacroAttribute"/> is applied on a template method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcActionAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
||||
is an MVC action. If applied to a method, the MVC action name is calculated
|
||||
implicitly from the context. Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcAreaAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC area.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcControllerAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is
|
||||
an MVC controller. If applied to a method, the MVC controller name is calculated
|
||||
implicitly from the context. Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcMasterAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC Master. Use this attribute
|
||||
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcModelTypeAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC model type. Use this attribute
|
||||
for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, Object)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcPartialViewAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC
|
||||
partial view. If applied to a method, the MVC partial view name is calculated implicitly
|
||||
from the context. Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcSuppressViewErrorAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcDisplayTemplateAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that a parameter is an MVC display template.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcEditorTemplateAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC editor template.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcTemplateAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. Indicates that the marked parameter is an MVC template.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcViewAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
||||
is an MVC view component. If applied to a method, the MVC view name is calculated implicitly
|
||||
from the context. Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.Mvc.Controller.View(Object)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcViewComponentAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
||||
is an MVC view component name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcViewComponentViewAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
||||
is an MVC view component view. If applied to a method, the MVC view component view name is default.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AspMvcActionSelectorAttribute">
|
||||
<summary>
|
||||
ASP.NET MVC attribute. When applied to a parameter of an attribute,
|
||||
indicates that this parameter is an MVC action name.
|
||||
</summary>
|
||||
<example><code>
|
||||
[ActionName("Foo")]
|
||||
public ActionResult Login(string returnUrl) {
|
||||
ViewBag.ReturnUrl = Url.Action("Foo"); // OK
|
||||
return RedirectToAction("Bar"); // Error: Cannot resolve action
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RazorSectionAttribute">
|
||||
<summary>
|
||||
Razor attribute. Indicates that the marked parameter or method is a Razor section.
|
||||
Use this attribute for custom wrappers similar to
|
||||
<c>System.Web.WebPages.WebPageBase.RenderSection(String)</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.CollectionAccessAttribute">
|
||||
<summary>
|
||||
Indicates how method, constructor invocation, or property access
|
||||
over collection type affects the contents of the collection.
|
||||
Use <see cref="P:JetBrains.Annotations.CollectionAccessAttribute.CollectionAccessType"/> to specify the access type.
|
||||
</summary>
|
||||
<remarks>
|
||||
Using this attribute only makes sense if all collection methods are marked with this attribute.
|
||||
</remarks>
|
||||
<example><code>
|
||||
public class MyStringCollection : List<string>
|
||||
{
|
||||
[CollectionAccess(CollectionAccessType.Read)]
|
||||
public string GetFirstString()
|
||||
{
|
||||
return this.ElementAt(0);
|
||||
}
|
||||
}
|
||||
class Test
|
||||
{
|
||||
public void Foo()
|
||||
{
|
||||
// Warning: Contents of the collection is never updated
|
||||
var col = new MyStringCollection();
|
||||
string x = col.GetFirstString();
|
||||
}
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.CollectionAccessType">
|
||||
<summary>
|
||||
Provides a value for the <see cref="T:JetBrains.Annotations.CollectionAccessAttribute"/> to define
|
||||
how the collection method invocation affects the contents of the collection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.CollectionAccessType.None">
|
||||
<summary>Method does not use or modify content of the collection.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.CollectionAccessType.Read">
|
||||
<summary>Method only reads content of the collection but does not modify it.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.CollectionAccessType.ModifyExistingContent">
|
||||
<summary>Method can change content of the collection but does not add new elements.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.CollectionAccessType.UpdatedContent">
|
||||
<summary>Method can add new elements to the collection.</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AssertionMethodAttribute">
|
||||
<summary>
|
||||
Indicates that the marked method is assertion method, i.e. it halts the control flow if
|
||||
one of the conditions is satisfied. To set the condition, mark one of the parameters with
|
||||
<see cref="T:JetBrains.Annotations.AssertionConditionAttribute"/> attribute.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AssertionConditionAttribute">
|
||||
<summary>
|
||||
Indicates the condition parameter of the assertion method. The method itself should be
|
||||
marked by <see cref="T:JetBrains.Annotations.AssertionMethodAttribute"/> attribute. The mandatory argument of
|
||||
the attribute is the assertion type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.AssertionConditionType">
|
||||
<summary>
|
||||
Specifies assertion type. If the assertion method argument satisfies the condition,
|
||||
then the execution continues. Otherwise, execution is assumed to be halted.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_TRUE">
|
||||
<summary>Marked parameter should be evaluated to true.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_FALSE">
|
||||
<summary>Marked parameter should be evaluated to false.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NULL">
|
||||
<summary>Marked parameter should be evaluated to null value.</summary>
|
||||
</member>
|
||||
<member name="F:JetBrains.Annotations.AssertionConditionType.IS_NOT_NULL">
|
||||
<summary>Marked parameter should be evaluated to not null value.</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.TerminatesProgramAttribute">
|
||||
<summary>
|
||||
Indicates that the marked method unconditionally terminates control flow execution.
|
||||
For example, it could unconditionally throw exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.LinqTunnelAttribute">
|
||||
<summary>
|
||||
Indicates that the method is a pure LINQ method, with postponed enumeration (like Enumerable.Select,
|
||||
.Where). This annotation allows inference of [InstantHandle] annotation for parameters
|
||||
of delegate type by analyzing LINQ method chains.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NoEnumerationAttribute">
|
||||
<summary>
|
||||
Indicates that IEnumerable passed as a parameter is not enumerated.
|
||||
Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection.
|
||||
</summary>
|
||||
<example><code>
|
||||
static void ThrowIfNull<T>([NoEnumeration] T v, string n) where T : class
|
||||
{
|
||||
// custom check for null but no enumeration
|
||||
}
|
||||
|
||||
void Foo(IEnumerable<string> values)
|
||||
{
|
||||
ThrowIfNull(values, nameof(values));
|
||||
var x = values.ToList(); // No warnings about multiple enumeration
|
||||
}
|
||||
</code></example>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RegexPatternAttribute">
|
||||
<summary>
|
||||
Indicates that the marked parameter, field, or property is a regular expression pattern.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.NoReorderAttribute">
|
||||
<summary>
|
||||
Prevents the Member Reordering feature from tossing members of the marked class.
|
||||
</summary>
|
||||
<remarks>
|
||||
The attribute must be mentioned in your member reordering patterns.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlItemsControlAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates the type that has <c>ItemsSource</c> property and should be treated
|
||||
as <c>ItemsControl</c>-derived type, to enable inner items <c>DataContext</c> type resolve.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlItemBindingOfItemsControlAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates the property of some <c>BindingBase</c>-derived type, that
|
||||
is used to bind some item of <c>ItemsControl</c>-derived type. This annotation will
|
||||
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
|
||||
</summary>
|
||||
<remarks>
|
||||
Property should have the tree ancestor of the <c>ItemsControl</c> type or
|
||||
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlItemStyleOfItemsControlAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates the property of some <c>Style</c>-derived type, that
|
||||
is used to style items of <c>ItemsControl</c>-derived type. This annotation will
|
||||
enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
|
||||
</summary>
|
||||
<remarks>
|
||||
Property should have the tree ancestor of the <c>ItemsControl</c> type or
|
||||
marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlOneWayBindingModeByDefaultAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates that DependencyProperty has <c>OneWay</c> binding mode by default.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.XamlTwoWayBindingModeByDefaultAttribute">
|
||||
<summary>
|
||||
XAML attribute. Indicates that DependencyProperty has <c>TwoWay</c> binding mode by default.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RouteTemplateAttribute">
|
||||
<summary>
|
||||
Indicates that the marked parameter, field, or property is a route template.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute allows IDE to recognize the use of web frameworks' route templates
|
||||
to enable syntax highlighting, code completion, navigation, rename and other features in string literals.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.RouteParameterConstraintAttribute">
|
||||
<summary>
|
||||
Indicates that the marked type is custom route parameter constraint,
|
||||
which is registered in application's Startup with name <c>ConstraintName</c>
|
||||
</summary>
|
||||
<remarks>
|
||||
You can specify <c>ProposedType</c> if target constraint matches only route parameters of specific type,
|
||||
it will allow IDE to create method's parameter from usage in route template
|
||||
with specified type instead of default <c>System.String</c>
|
||||
and check if constraint's proposed type conflicts with matched parameter's type
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:JetBrains.Annotations.UriStringAttribute">
|
||||
<summary>
|
||||
Indicates that the marked parameter, field, or property is an URI string.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute enables code completion, navigation, rename and other features
|
||||
in URI string literals assigned to annotated parameter, field or property.
|
||||
</remarks>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"runtimeTarget": {
|
||||
"name": ".NETStandard,Version=v2.0/",
|
||||
"signature": ""
|
||||
},
|
||||
"compilationOptions": {},
|
||||
"targets": {
|
||||
".NETStandard,Version=v2.0": {},
|
||||
".NETStandard,Version=v2.0/": {
|
||||
"JetBrains.Annotations/2021.2": {
|
||||
"dependencies": {
|
||||
"NETStandard.Library": "2.0.3"
|
||||
},
|
||||
"runtime": {
|
||||
"JetBrains.Annotations.dll": {}
|
||||
}
|
||||
},
|
||||
"Microsoft.NETCore.Platforms/1.1.0": {},
|
||||
"NETStandard.Library/2.0.3": {
|
||||
"dependencies": {
|
||||
"Microsoft.NETCore.Platforms": "1.1.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"libraries": {
|
||||
"JetBrains.Annotations/2021.2": {
|
||||
"type": "project",
|
||||
"serviceable": false,
|
||||
"sha512": ""
|
||||
},
|
||||
"Microsoft.NETCore.Platforms/1.1.0": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-kz0PEW2lhqygehI/d6XsPCQzD7ff7gUJaVGPVETX611eadGsA3A877GdSlU0LRVMCTH/+P3o2iDTak+S08V2+A==",
|
||||
"path": "microsoft.netcore.platforms/1.1.0",
|
||||
"hashPath": "microsoft.netcore.platforms.1.1.0.nupkg.sha512"
|
||||
},
|
||||
"NETStandard.Library/2.0.3": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-st47PosZSHrjECdjeIzZQbzivYBJFv6P2nv4cj2ypdI204DO+vZ7l5raGMiX4eXMJ53RfOIg+/s4DHVZ54Nu2A==",
|
||||
"path": "netstandard.library/2.0.3",
|
||||
"hashPath": "netstandard.library.2.0.3.nupkg.sha512"
|
||||
}
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user