GithubHelp home page GithubHelp logo

Comments (1)

slorber avatar slorber commented on April 28, 2024

Hey

This is more a question than a bug to me.

import type { SidebarItemConfig } from '@docusaurus/plugin-content-docs/lib/sidebars/types'

As far as I know, we never documented anywhere to add such import. Even if it worked, it is importing internal code and might break anytime if we refactor types.


Note that in any case, you could use TypeScript type system to "extract" the types you need. Adding an extra type export does not this ability: it only makes it more convenient.

import {SidebarsConfig} from '@docusaurus/plugin-content-docs';

type SidebarConfig = SidebarsConfig[string];
type OnlyArray<Type> = Type extends unknown[] ? Type : never;
type SidebarItemConfigArray = OnlyArray<SidebarConfig>;
type SidebarItemConfig = SidebarItemConfigArray[number];

I still don't understand why you need to import that type exactly. Please provide a repro showing the problem with the TS error you encounter, and we might eventually decide to export it to make it more convenient.

I assigned this category to a new const and dropped it into both sidebar slices, but then got an error is not assignable to type 'SidebarItemConfig'. (full error not posted, it's a big ugly TS error)

I'm not able to understand what you mean here without seeing a repro, or at least a full sidebar file example including the error messages you encounter. We'll eventually reopen if you provide enough info to understand better the problem and judge whether it's worth improving something.

My intuition is that as const could also do the trick in your case, but I can't be sure without seeing the code.

from docusaurus.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.