index.ts 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. import type { LibPage } from './types';
  2. export const page: LibPage = {
  3. name: 'memfs',
  4. title: 'memfs',
  5. type: 'lib',
  6. subtitle: 'In-memory Node.js fs API and browser File System Access API.',
  7. pkg: 'memfs',
  8. group: 'tooling',
  9. repo: 'streamich/memfs',
  10. repoPath: 'tree/master/packages/memfs',
  11. tech: 'TypeScript',
  12. techIcon: { set: 'lineicons', icon: 'typescript' },
  13. showContentsTable: true,
  14. children: [
  15. {
  16. name: 'Node fs API',
  17. subtitle: 'The in-memory fs module: fs, vol, Volume, memfs(), and the supported method surface.',
  18. // @ts-ignore
  19. src: async () => (await import('./node.md')).default,
  20. },
  21. {
  22. name: 'Volumes',
  23. subtitle: 'Create volumes from JSON, export them back, and combine memfs with unionfs and fs-monkey.',
  24. // @ts-ignore
  25. src: async () => (await import('./volumes.md')).default,
  26. },
  27. {
  28. name: 'File System Access',
  29. subtitle: 'An in-memory implementation of the browser File System (Access) (FSA) API.',
  30. // @ts-ignore
  31. src: async () => (await import('./fsa.md')).default,
  32. },
  33. {
  34. name: 'Adapters',
  35. subtitle: 'Bridge between the Node fs API and the FSA API in either direction, including a sync bridge.',
  36. // @ts-ignore
  37. src: async () => (await import('./adapters.md')).default,
  38. },
  39. {
  40. name: 'Snapshots',
  41. subtitle: 'POJO, CBOR, and JSON snapshots of any fs directory, preserving symlinks and binary data.',
  42. // @ts-ignore
  43. src: async () => (await import('./snapshot.md')).default,
  44. },
  45. {
  46. name: 'Tree printing',
  47. subtitle: 'Render an ASCII tree of any fs directory.',
  48. // @ts-ignore
  49. src: async () => (await import('./print.md')).default,
  50. },
  51. ],
  52. // @ts-ignore
  53. src: async () => (await import('./text.md')).default,
  54. };